add readme and documentation

Author: Kirill Platonov

.gitignore

@@ -1,3 +1,7 @@
 .bundle/
 log/*.log
-pkg/
+pkg/
+Gemfile.lock
+tmp
+.yardoc/
+doc/

.yardopts

@@ -0,0 +1,3 @@
+--private
+--protected
+-o doc/ruby

Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    proxy_manager (0.0.1)
-      net-ping
+    proxy_manager (0.0.2)
+      net-ping (~> 1.7, >= 1.7.2)
 
 GEM
   remote: https://rubygems.org/
@@ -51,7 +51,7 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
+    rspec-core (2.14.8)
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
@@ -62,14 +62,16 @@ GEM
     turn (0.9.7)
       ansi
       minitest (~> 4)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  fuubar
-  growl
-  guard-rspec
+  fuubar (>= 1.3.2)
+  growl (>= 1.0.3)
+  guard-rspec (>= 4.2.8)
   proxy_manager!
-  rspec
-  turn
+  rspec (>= 2.14.1)
+  turn (>= 0.9.7)
+  yard (>= 0.8.7.4)

README.md

@@ -0,0 +1,95 @@
+# Ruby Proxy Manager
+
+Easy manage proxy in your parsers/web-bots.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'proxy_manager'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install proxy_manager
+```
+
+## Usage
+
+### Load proxy list
+
+From array (IP:PORT)
+
+```ruby
+proxy = ProxyManager.load(['1.2.3.4:567', '9.8.7.6:543'])
+```
+
+or from file
+
+```ruby
+proxy = ProxyManager.load('proxies.txt', 'bad_proxies.txt')
+```
+
+Files `proxies.txt` and `bad_proxies.txt` should be writable.
+Example of `proxies.txt` content:
+
+```
+1.2.3.4:567
+9.8.7.6:543
+...
+```
+
+### Get proxy
+
+Get one proxy
+
+```ruby
+proxy.get
+# => ["1.2.3.4", 567]
+```
+
+Get many proxies
+
+```ruby
+proxy.get(2)
+# => [["1.2.3.4", 567], ["9.8.7.6", 543]]
+```
+
+Will be returning only pingable proxies
+
+### Proxies lists
+
+You also can display list of loaded proxies
+
+```ruby
+proxy.list
+# => [["1.2.3.4", 567], ["9.8.7.6", 543]]
+```
+
+and list of bad proxies
+
+```ruby
+proxy.bad_list
+# => []
+```
+
+## Documentation
+
+http://rubydoc.info/gems/proxy_manager/frames
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

README.rdoc

@@ -2,10 +2,23 @@
 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

lib/proxy_manager.rb

@@ -3,8 +3,9 @@ $:.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.2'
+  s.version     = '0.0.3'
   s.authors     = ["Kirill Platonov"]
+  s.licenses    = ['MIT']
   s.email       = ["[email protected]"]
   s.homepage    = "https://github.com/bloodyhistory/proxy_manager"
   s.summary     = "Ruby proxy manager. Gem for easy usage proxy in parser/web bots."
@@ -16,11 +17,12 @@ Gem::Specification.new do |s|
   s.files = Dir["{lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc", ".rspec"]
   s.test_files = Dir["spec/**/*"]
 
-  s.add_dependency 'net-ping'
+  s.add_dependency 'net-ping', '~> 1.7', '>= 1.7.2'
 
-  s.add_development_dependency 'turn'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'growl'
-  s.add_development_dependency 'fuubar'
+  s.add_development_dependency 'turn', '>= 0.9.7'
+  s.add_development_dependency 'rspec', '>= 2.14.1'
+  s.add_development_dependency 'guard-rspec', '>= 4.2.8'
+  s.add_development_dependency 'growl', '>= 1.0.3'
+  s.add_development_dependency 'fuubar', '>= 1.3.2'
+  s.add_development_dependency 'yard', '>= 0.8.7.4'
 end