onion 0.1.0

data/README.rdoc

@@ -0,0 +1,40 @@
+= Onion
+
+== Introduction
+
+Onion is a library for interacting with Tor. Onion is in an alpha state and is
+made availible for early adopters and contributors only.
+
+== Functionality
+
+ * Parse router status entries per the directory protocol version 2.0.
+
+== Authors
+
+Onion was written by Tim Sally <poet@stack.io>. Please send bug reports and
+suggestions to the author.
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2010 Tim Sally
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.warning = true
+  t.spec_files = FileList["#{File.dirname(__FILE__)}/spec/**/*_spec.rb"]
+  t.spec_opts = %w(--backtrace --diff --color)
+  t.libs << "#{File.dirname(__FILE__)}/spec"
+  t.libs << "#{File.dirname(__FILE__)}/spec/onion"
+end
+
+desc "Build a gem file."
+task :build do
+  system "gem build onion.gemspec"
+end
+
+# Load custom rake tasks.
+Dir["#{File.dirname(__FILE__)}/lib/tasks/**/*.rake"].sort.each do |task|
+  load task
+end

data/lib/onion.rb

@@ -0,0 +1,19 @@
+module Onion
+
+  require 'onion/elements'
+
+  parsers = %w[ router_lists ]
+  parsers.each do |parser|
+    begin
+      # If there is a pre-compiled parser, load it.
+      require 'treetop/runtime'
+      require "onion/parsers/#{parser}"
+    rescue LoadError
+      # Otherwise compiler with Treetop.
+      require 'treetop/runtime'
+      require 'treetop/compiler'
+      Treetop.load(File.join(File.dirname(__FILE__)) + "/onion/parsers/#{parser}")
+    end
+  end
+
+end

data/lib/onion/elements.rb

@@ -0,0 +1,4 @@
+module Onion
+  autoload :Router, 'onion/elements/router'
+  autoload :RouterList, 'onion/elements/router_list'
+end

data/lib/onion/elements/router.rb

@@ -0,0 +1,18 @@
+module Onion
+  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
+    end
+
+    def guard?
+      @status_flags and @status_flags.include?("Guard")
+    end
+
+    def exit?
+      @status_flags and @status_flags.include?("Exit")
+    end
+  end
+end

data/lib/onion/elements/router_list.rb

@@ -0,0 +1,17 @@
+module Onion
+  class RouterList
+    attr_reader :routers
+    def initialize(text)
+      if text.blank?
+        @routers = []
+        return self
+      end
+      parser = Onion::RouterListsParser.new
+      if nodes  = parser.parse(text)
+        @routers = nodes.routers
+      else
+        raise Exception "Couldn't parse #{text} b/c #{parser.failure_reason}."
+      end
+    end
+  end
+end

data/lib/onion/parsers/router_lists.treetop

@@ -0,0 +1,133 @@
+module Onion
+  grammar RouterLists
+
+    # --- Rule to start matching against. ----------------------------------- #
+
+    rule router_list
+      router_list_entry+ {
+        def routers
+          routers = []
+          self.elements.each do |e|
+            if e.respond_to? :s # Optional status flags are in the entry.
+              routers << Onion::Router.new(e.r.nick, e.r.id_hash, e.s.flags)
+            else
+              routers << Onion::Router.new(e.r_nos.nick, e.r_nos.id_hash, nil)
+            end
+          end
+          return routers
+        end
+      }
+    end
+
+    rule router_list_entry
+      r:router "\n" s:status "\n" / r_nos:router "\n"
+    end
+
+    # --- General use rules. ------------------------------------------------ #
+
+    rule base64_char
+      [A-Za-z0-9+/]
+    end
+
+    rule year
+      [0-9] [0-9] [0-9] [0-9]
+    end
+
+    rule month
+      [0] [1-9] / [1] [0-2]
+    end
+
+    rule day
+      [0-2] [0-9] / [3] [0-1]
+    end
+
+    rule hour
+      [0] [1-9] / [1] [0-9] / [2] [0-4]
+    end
+
+    rule minute
+      [0] [0-9] / [1-5] [0-9]
+    end
+
+    rule second
+      [0] [0-9] / [1-5] [0-9]
+    end
+
+    rule ip_addr_byte
+      [2] [5] [0-5] / [2] [0-4] [0-9] / [1] [0-9] [0-9] / [1-9] [0-9] / [0-9]
+    end
+
+    rule sp
+      " "+
+    end
+
+    # --- Rules needed to parse the router lines. --------------------------- #
+
+    rule router
+      "r " n:nick id:id_hash desc_hash desc_time ip_addr or_port dir_port {
+        def nick
+          n.text_value.strip
+        end
+
+        def id_hash
+          id.text_value.strip
+        end
+      }
+    end
+
+    rule nick
+      # TODO: This should be 1-19 alphanumeric chars, but this isn't easy
+      #       to do in Treetop.
+      [a-zA-Z0-9]+ sp
+    end
+
+    rule id_hash
+      base64_char+ sp
+    end
+
+    rule desc_hash
+      base64_char+ sp
+    end
+
+    rule desc_time
+      year "-" month "-" day " " hour ":" minute ":" second sp
+    end
+
+    rule ip_addr
+      ip_addr_byte "." ip_addr_byte "." ip_addr_byte "." ip_addr_byte sp
+    end
+
+    rule or_port
+      [0-9]+ sp
+    end
+
+    rule dir_port
+      [0-9]+ sp?
+    end
+
+    # --- Rules needed to parse the status lines. --------------------------- #
+
+    rule status
+      "s " (valid:status_flag sp? / invalid_status_flag sp?)+ {
+        def flags
+          results = []
+          self.elements[1].elements.each do |e|
+            if e.respond_to? :valid
+              results << e.valid.text_value
+            end
+          end
+          return results
+        end
+      }
+    end
+
+    rule status_flag
+       "Authority" / "BadExit" / "BadDirectory" / "Exit" / "Fast"
+        / "Guard" / "Named" / "Stable" / "Running" / "Valid" / "V2Dir"
+    end
+
+    rule invalid_status_flag
+      [a-zA-Z]+
+    end
+  end
+end

data/lib/tasks/treetop.rake

@@ -0,0 +1,10 @@
+namespace :tt do
+  desc "Generate Ruby parsers from Treetop grammars."
+  task :gen do
+    task_path = File.expand_path('../../lib/onion/parsers/*.treetop', __FILE__)
+    Dir.glob(task_path) do |filename|
+#      `tt #{filename}`
+      `bundle exec tt #{filename}`
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: onion
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Poet (Tim Sally)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 4
+        - 8
+        version: 1.4.8
+  type: :runtime
+  version_requirements: *id001
+description: Interact with Tor.
+email: poet@stack.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- Rakefile
+- lib/onion/elements/router.rb
+- lib/onion/elements/router_list.rb
+- lib/onion/elements.rb
+- lib/onion/parsers/router_lists.treetop
+- lib/onion.rb
+- lib/tasks/treetop.rake
+has_rdoc: true
+homepage: http://stack.io
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Onion is a library you can use to interact with Tor.  It includes parsers and clients for Tor's protocols.
+test_files: []
+