onion 0.1.0 → 0.1.1

data/lib/onion/elements/router.rb

@@ -1,16 +1,19 @@
 module Onion
+  # Onion::Router is a Ruby object representing a Tor router.
   class Router
     attr_reader :nick, :id_key_hash, :status_flags
     def initialize(nick, id_key_hash, status_flags)
-      @nick         = nick
-      @id_key_hash  = id_key_hash
-      @status_flags = status_flags
+      @nick         = nick         # Nickname of the router.
+      @id_key_hash  = id_key_hash  # Hash of the router identity key.
+      @status_flags = status_flags # Array of strings with status flags.
     end
 
+    # Returns true if the rotuer is a guard router, false otherwise.
     def guard?
       @status_flags and @status_flags.include?("Guard")
     end
 
+    # Returns true if the router is an exit router, false otherwise.
     def exit?
       @status_flags and @status_flags.include?("Exit")
     end

data/lib/onion/elements/router_list.rb

@@ -1,4 +1,7 @@
 module Onion
+  # Onion::RouterList is a list of Onion::Router objects. On initialization,
+  # the text given is parsed with Onion::RouterListParser. The text should be
+  # in the router status format specified by the directory protocol 2.0 spec.
   class RouterList
     attr_reader :routers
     def initialize(text)
@@ -13,5 +16,20 @@ module Onion
         raise Exception "Couldn't parse #{text} b/c #{parser.failure_reason}."
       end
     end
+
+    # Returns the routers that are guard routers.
+    def guards
+      @routers.select { |r| r.guard? }
+    end
+
+    # Returns the routers that are exit routers.
+    def exits
+      @routers.select { |r| r.exit? }
+    end
+
+    # Returns the routers that are neither guard or exit routers.
+    def middlemen
+      @routers.filter { |r| r.guard? or r.exit? }
+    end
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: onion
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Poet (Tim Sally)
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 -05:00
+date: 2010-10-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 4
@@ -65,7 +63,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -74,7 +71,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"