tormanager 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04505aabbc5658c80ee5124866e5fa939a1d42d1
-  data.tar.gz: 7798de7e4ac6228cc2afd6e2bf68873d94fcbc82
+  metadata.gz: ae9cd4db1d87b48b12d3c7da7f27ec8f73a03fd9
+  data.tar.gz: bc8871a5eca69b0ab3d66b283ada7094138901c7
 SHA512:
-  metadata.gz: cf53e41f6cab0da777462c69a526e63de3dc5802fac1b07b82425d5ba66cadcd3f62b115fb948354e4dcbd9417aa15d5eb8410686558a86a9cfe381191c87726
-  data.tar.gz: e7828a3ae09c95e22ee3f04dbb5abcf71efc7264a024da5f6ec441e3f3f35b40cd58c0973b8f1022d784b2898cc4e029c327651cb343344edc00e26ad350ab90
+  metadata.gz: bbfdd160272d2bc25b8b29e67afaffbf9ef642c233e86ad541a80d8205df2bf188d97a8a501aaa9770222cb08cab10fa1c5f18369082449cf03c8a24962296d1
+  data.tar.gz: 6dd60fc33690fd71c64c62a8181311b81389af36f4c3d58c57689028c75b5c1abaa638b862e42e02d44aae772f951e9fda1b21acc8cea6c6f440db01899cf47b

data/README.md

@@ -35,11 +35,13 @@ This section shows how to start, stop and manage Tor processes.
 
 Start a Tor process with default settings:
 
-    tor_process = TorManager::TorProcess.new
-    tor_process.start
-	
-	#you can get the control password for the Tor process if you want: 
-	tor_process.settings[:control_password]
+```ruby
+tor_process = TorManager::TorProcess.new
+tor_process.start
+
+#you can get the control password for the Tor process if you want: 
+tor_process.settings[:control_password]
+```
 
 By default, the Tor process will use using port `9050` and control port `50500` and
 will be spawned using [Eye](https://github.com/kostya/eye) ensuring that the process remains in a healthy state. 
@@ -55,25 +57,29 @@ More information can be found in the `TorManager::TorProcess` parameters table b
 
 You can also spawn a Tor process with control over parameters:
 
-    tor_process = 
-	  TorManager::TorProcess.new tor_port: 9051, 
-	                             control_port: 50501, 
-                                 pid_dir: '/my/pid/dir',
-                                 log_dir: '/my/log/dir',
-                                 tor_data_dir: '/my/tor/datadir',
-                                 tor_new_circuit_period: 120,
-                                 max_tor_memory_usage_mb: 400,
-                                 max_tor_cpu_percentage: 15,
-                                 control_password: 'mycontrolpass',
-                                 eye_logging: true,
-                                 tor_logging: true
-    tor_process.start
+```ruby
+tor_process = 
+  TorManager::TorProcess.new tor_port: 9051, 
+                             control_port: 50501, 
+                             pid_dir: '/my/pid/dir',
+                             log_dir: '/my/log/dir',
+                             tor_data_dir: '/my/tor/datadir',
+                             tor_new_circuit_period: 120,
+                             max_tor_memory_usage_mb: 400,
+                             max_tor_cpu_percentage: 15,
+                             control_password: 'mycontrolpass',
+                             eye_logging: true,
+                             tor_logging: true
+tor_process.start
+```
 
 See the table below for more info.	
 	
 When done with the Tor process, `stop` it: 
 
-    tor_process.stop 
+```ruby
+tor_process.stop 
+```
 	
 The following table describes the `TorManager::TorProcess` parameters:
 	
@@ -98,15 +104,21 @@ The following table describes the `TorManager::TorProcess` parameters:
 
 To stop any Tor instances that have been previously started by Tor Manager but were not stopped (say in the event of a parent process crash) **_††_**: 
 
-    TorProcess.stop_obsolete_processes 
+```ruby
+TorManager::TorProcess.stop_obsolete_processes 
+```
 	
 Query whether Tor Manager has any Tor processes running on a particular port **_††_**: 
 
-    TorProcess.tor_running_on? port: 9050 
+```ruby
+TorManager::TorProcess.tor_running_on? port: 9050 
+```
 
 Query whether Tor Manager has any Tor processes running on a particular port associated to a particular parent ruby pid **_††_**:
 
-    TorProcess.tor_running_on? port: 9050, parent_pid: 12345
+```ruby
+TorManager::TorProcess.tor_running_on? port: 9050, parent_pid: 12345
+```
 
 **_††_** Note that this command applies only to Tor processes that were started by Tor Manager. 
 Tor processes that have been started external to Tor Manager will not be impacted.  
@@ -121,20 +133,24 @@ Once you have a `TorProcess` started, you can:
 
 The remaining examples assume that you have instantiated a `TorProcess` ie: 
 
-    tor_process = TorManager::TorProcess.new
-    tor_process.start
+```ruby
+tor_process = TorManager::TorProcess.new
+tor_process.start
+```
 
 #### Proxy Through Tor
-	
-    tor_proxy = TorManager::Proxy.new tor_process: tor_process 
-    tor_proxy.proxy do 
-      tor_ip = RestClient::Request.execute(
-                 method: :get,
-                 url: 'http://bot.whatismyipaddress.com').to_str
-    end
-	my_ip = RestClient::Request.execute(
-	             method: :get,
-                 url: 'http://bot.whatismyipaddress.com').to_str
+
+```ruby
+tor_proxy = TorManager::Proxy.new tor_process: tor_process 
+tor_proxy.proxy do 
+  tor_ip = RestClient::Request.execute(
+             method: :get,
+             url: 'http://bot.whatismyipaddress.com').to_str
+end
+my_ip = RestClient::Request.execute(
+             method: :get,
+             url: 'http://bot.whatismyipaddress.com').to_str
+```
 	
 Note that in the above code the `RestClient::Request` returning `tor_ip` is routed through the Tor endpoint because it is yielded 
 through the `TorManager::Proxy#proxy` block. The following request returning `my_ip` will not be routed through the Tor endpoint 
@@ -143,47 +159,55 @@ hence returning your current IP address.
 You could route [Capybara](https://github.com/teamcapybara/capybara) requests through the proxy (just make sure you use the `:poltergeist` driver and set the proxy 
 to use the Tor socks proxy): 
 
-    Capybara.default_driver = :poltergeist
-    Capybara.register_driver :poltergeist do |app|
-      Capybara::Poltergeist::Driver.new(app, {
-        :phantomjs => Phantomjs.path,
-        :phantomjs_options => ["--proxy-type=socks5", "--proxy=127.0.0.1:9050"]
-      })
-    end
-    tor_proxy = TorManager::Proxy.new tor_process: tor_process 
-    tor_proxy.proxy do 
-      tor_ip = Capybara.visit('http://bot.whatismyipaddress.com').text
-    end
+```ruby
+Capybara.default_driver = :poltergeist
+Capybara.register_driver :poltergeist do |app|
+  Capybara::Poltergeist::Driver.new(app, {
+    :phantomjs => Phantomjs.path,
+    :phantomjs_options => ["--proxy-type=socks5", "--proxy=127.0.0.1:9050"]
+  })
+end
+tor_proxy = TorManager::Proxy.new tor_process: tor_process 
+tor_proxy.proxy do 
+  tor_ip = Capybara.visit('http://bot.whatismyipaddress.com').text
+end
+```
 
 #### Query IP Address 
 
 Query the Tor endpoint for the current IP address: 
 
-    tor_proxy = TorManager::Proxy.new tor_process: tor_process 	
-    tor_ip_control = 
-	  TorManager::IpAddressControl.new tor_process: tor_process, 
-                                       tor_proxy: tor_proxy 
-    tor_ip_control.get_ip									   
+```ruby
+tor_proxy = TorManager::Proxy.new tor_process: tor_process 	
+tor_ip_control = 
+  TorManager::IpAddressControl.new tor_process: tor_process, 
+                                   tor_proxy: tor_proxy 
+tor_ip_control.get_ip									   
+```
 	
 When the `TorManager::IpAddressControl#get_ip` method is called, the IP address is stored in instance variable: 
 
-    tor_ip_control.ip 
-
+```ruby
+tor_ip_control.ip 
+```
 	
 #### Change IP Address
 
 Get a new IP address: 
 
-    tor_proxy = TorManager::Proxy.new tor_process: tor_process 	
-    tor_ip_control = 
-	  TorManager::IpAddressControl.new tor_process: tor_process, 
-                                       tor_proxy: tor_proxy 
-    tor_ip_control.get_new_ip									   
-	
-When the `TorManager::IpAddressControl#get_new_ip` method is called, the IP address is stored in instance variable: 
+```ruby
+tor_proxy = TorManager::Proxy.new tor_process: tor_process 	
+tor_ip_control = 
+  TorManager::IpAddressControl.new tor_process: tor_process, 
+                                   tor_proxy: tor_proxy 
+tor_ip_control.get_new_ip									   
+```
 
-    tor_ip_control.ip
+When the `TorManager::IpAddressControl#get_new_ip` method is called, the IP address is stored in instance variable: 
 
+```ruby
+tor_ip_control.ip
+```
 	
 ## Contributing
 

data/lib/tormanager/version.rb

@@ -1,3 +1,3 @@
 module TorManager
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tormanager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - joshweir