rtor 0.1.0

data/MIT-LICENSE.txt

@@ -0,0 +1,18 @@
+Copyright (C) 2011 by 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

data/README.txt

@@ -0,0 +1 @@
+A Ruby library for interacting with Tor.

data/Rakefile

@@ -0,0 +1,20 @@
+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 --color)
+end
+
+desc "Build a gem file."
+task :build do
+  system "gem build rtor.gemspec"
+end
+
+# Load custom rake tasks.
+Dir["#{File.dirname(__FILE__)}/lib/tasks/**/*.rake"].sort.each do |task|
+  load task
+end

data/lib/rtor.rb

@@ -0,0 +1,15 @@
+module RTor
+  grammars = %w[ primitives ]
+  grammars.each do |g|
+    begin
+      # If there is a pre-compiled grammar, load it.
+      require 'treetop/runtime'
+      require "rtor/#{g}"
+    rescue LoadError
+      # Otherwise, compile the grammar with Treetop."
+      require 'treetop/runtime'
+      require 'treetop/compiler'
+      Treetop.load(File.join(File.dirname(__FILE__) + "/rtor/#{g}"))
+    end
+  end
+end

data/lib/rtor/dirspecv2/network_status.treetop

@@ -0,0 +1,23 @@
+module RTor
+  module DirspecV2
+    grammar NetworkStatus
+    include Primitives 
+
+      rule NetworkStatusVersion
+        "network-status-version 2"
+      end
+
+      rule DirSourceLine
+        "dir-source" SP Hostname SP IPv4Address SP DirPort
+      end
+
+      rule FingerprintLine
+        "fingerprint" SP Fingerprint
+      end
+
+      rule PublishedLine
+        "published" SP DateTime
+      end
+    end
+  end
+end

data/lib/rtor/dirspecv2/network_status_parser.rb

@@ -0,0 +1,231 @@
+# Autogenerated from a Treetop grammar. Edits may be lost.
+
+
+module RTor
+  module DirspecV2
+    module NetworkStatus
+      include Treetop::Runtime
+
+      def root
+        @root ||= :NetworkStatusVersion
+      end
+
+      include Primitives
+
+      def _nt_NetworkStatusVersion
+        start_index = index
+        if node_cache[:NetworkStatusVersion].has_key?(index)
+          cached = node_cache[:NetworkStatusVersion][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        if has_terminal?("network-status-version 2", false, index)
+          r0 = instantiate_node(SyntaxNode,input, index...(index + 24))
+          @index += 24
+        else
+          terminal_parse_failure("network-status-version 2")
+          r0 = nil
+        end
+
+        node_cache[:NetworkStatusVersion][start_index] = r0
+
+        r0
+      end
+
+      module DirSourceLine0
+        def SP1
+          elements[1]
+        end
+
+        def Hostname
+          elements[2]
+        end
+
+        def SP2
+          elements[3]
+        end
+
+        def IPv4Address
+          elements[4]
+        end
+
+        def SP3
+          elements[5]
+        end
+
+        def DirPort
+          elements[6]
+        end
+      end
+
+      def _nt_DirSourceLine
+        start_index = index
+        if node_cache[:DirSourceLine].has_key?(index)
+          cached = node_cache[:DirSourceLine][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("dir-source", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 10))
+          @index += 10
+        else
+          terminal_parse_failure("dir-source")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_SP
+          s0 << r2
+          if r2
+            r3 = _nt_Hostname
+            s0 << r3
+            if r3
+              r4 = _nt_SP
+              s0 << r4
+              if r4
+                r5 = _nt_IPv4Address
+                s0 << r5
+                if r5
+                  r6 = _nt_SP
+                  s0 << r6
+                  if r6
+                    r7 = _nt_DirPort
+                    s0 << r7
+                  end
+                end
+              end
+            end
+          end
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(DirSourceLine0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:DirSourceLine][start_index] = r0
+
+        r0
+      end
+
+      module FingerprintLine0
+        def SP
+          elements[1]
+        end
+
+        def Fingerprint
+          elements[2]
+        end
+      end
+
+      def _nt_FingerprintLine
+        start_index = index
+        if node_cache[:FingerprintLine].has_key?(index)
+          cached = node_cache[:FingerprintLine][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("fingerprint", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 11))
+          @index += 11
+        else
+          terminal_parse_failure("fingerprint")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_SP
+          s0 << r2
+          if r2
+            r3 = _nt_Fingerprint
+            s0 << r3
+          end
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(FingerprintLine0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:FingerprintLine][start_index] = r0
+
+        r0
+      end
+
+      module PublishedLine0
+        def SP
+          elements[1]
+        end
+
+        def DateTime
+          elements[2]
+        end
+      end
+
+      def _nt_PublishedLine
+        start_index = index
+        if node_cache[:PublishedLine].has_key?(index)
+          cached = node_cache[:PublishedLine][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("published", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 9))
+          @index += 9
+        else
+          terminal_parse_failure("published")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_SP
+          s0 << r2
+          if r2
+            r3 = _nt_DateTime
+            s0 << r3
+          end
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(PublishedLine0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:PublishedLine][start_index] = r0
+
+        r0
+      end
+
+    end
+
+    class NetworkStatusParser < Treetop::Runtime::CompiledParser
+      include NetworkStatus
+    end
+
+  end
+end

data/lib/rtor/dirspecv2/router_descriptor.treetop

@@ -0,0 +1,32 @@
+module RTor
+  module DirspecV2
+    grammar RouterDescriptor
+      include Primitives
+      
+      rule Descriptor
+        RouterItem / NL
+      end
+
+      rule RouterItem
+        "router" Nickname Address ORPort SocksPort DirPort      
+      end
+
+      rule BandwidthItem
+        "bandwidth" BandwidthAvg BandwidthBurst BandwidthObserved
+      end
+
+      rule PlatformItem
+        "platform" String
+      end
+
+      rule PublishedItem
+        "published" DateTime
+      end
+
+      rule HibernatingItem
+        "hibernating" Boolean
+      end
+      
+    end
+  end
+end

data/lib/rtor/dirspecv2/router_descriptor_parser.rb

@@ -0,0 +1,315 @@
+# Autogenerated from a Treetop grammar. Edits may be lost.
+
+
+module RTor
+  module DirspecV2
+    module RouterDescriptor
+      include Treetop::Runtime
+
+      def root
+        @root ||= :Descriptor
+      end
+
+      include Primitives
+
+      def _nt_Descriptor
+        start_index = index
+        if node_cache[:Descriptor].has_key?(index)
+          cached = node_cache[:Descriptor][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0 = index
+        r1 = _nt_RouterItem
+        if r1
+          r0 = r1
+        else
+          r2 = _nt_NL
+          if r2
+            r0 = r2
+          else
+            @index = i0
+            r0 = nil
+          end
+        end
+
+        node_cache[:Descriptor][start_index] = r0
+
+        r0
+      end
+
+      module RouterItem0
+        def Nickname
+          elements[1]
+        end
+
+        def Address
+          elements[2]
+        end
+
+        def ORPort
+          elements[3]
+        end
+
+        def SocksPort
+          elements[4]
+        end
+
+        def DirPort
+          elements[5]
+        end
+      end
+
+      def _nt_RouterItem
+        start_index = index
+        if node_cache[:RouterItem].has_key?(index)
+          cached = node_cache[:RouterItem][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("router", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 6))
+          @index += 6
+        else
+          terminal_parse_failure("router")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_Nickname
+          s0 << r2
+          if r2
+            r3 = _nt_Address
+            s0 << r3
+            if r3
+              r4 = _nt_ORPort
+              s0 << r4
+              if r4
+                r5 = _nt_SocksPort
+                s0 << r5
+                if r5
+                  r6 = _nt_DirPort
+                  s0 << r6
+                end
+              end
+            end
+          end
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(RouterItem0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:RouterItem][start_index] = r0
+
+        r0
+      end
+
+      module BandwidthItem0
+        def BandwidthAvg
+          elements[1]
+        end
+
+        def BandwidthBurst
+          elements[2]
+        end
+
+        def BandwidthObserved
+          elements[3]
+        end
+      end
+
+      def _nt_BandwidthItem
+        start_index = index
+        if node_cache[:BandwidthItem].has_key?(index)
+          cached = node_cache[:BandwidthItem][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("bandwidth", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 9))
+          @index += 9
+        else
+          terminal_parse_failure("bandwidth")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_BandwidthAvg
+          s0 << r2
+          if r2
+            r3 = _nt_BandwidthBurst
+            s0 << r3
+            if r3
+              r4 = _nt_BandwidthObserved
+              s0 << r4
+            end
+          end
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(BandwidthItem0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:BandwidthItem][start_index] = r0
+
+        r0
+      end
+
+      module PlatformItem0
+        def String
+          elements[1]
+        end
+      end
+
+      def _nt_PlatformItem
+        start_index = index
+        if node_cache[:PlatformItem].has_key?(index)
+          cached = node_cache[:PlatformItem][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("platform", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 8))
+          @index += 8
+        else
+          terminal_parse_failure("platform")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_String
+          s0 << r2
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(PlatformItem0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:PlatformItem][start_index] = r0
+
+        r0
+      end
+
+      module PublishedItem0
+        def DateTime
+          elements[1]
+        end
+      end
+
+      def _nt_PublishedItem
+        start_index = index
+        if node_cache[:PublishedItem].has_key?(index)
+          cached = node_cache[:PublishedItem][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("published", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 9))
+          @index += 9
+        else
+          terminal_parse_failure("published")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_DateTime
+          s0 << r2
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(PublishedItem0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:PublishedItem][start_index] = r0
+
+        r0
+      end
+
+      module HibernatingItem0
+        def Boolean
+          elements[1]
+        end
+      end
+
+      def _nt_HibernatingItem
+        start_index = index
+        if node_cache[:HibernatingItem].has_key?(index)
+          cached = node_cache[:HibernatingItem][index]
+          if cached
+            cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+            @index = cached.interval.end
+          end
+          return cached
+        end
+
+        i0, s0 = index, []
+        if has_terminal?("hibernating", false, index)
+          r1 = instantiate_node(SyntaxNode,input, index...(index + 11))
+          @index += 11
+        else
+          terminal_parse_failure("hibernating")
+          r1 = nil
+        end
+        s0 << r1
+        if r1
+          r2 = _nt_Boolean
+          s0 << r2
+        end
+        if s0.last
+          r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+          r0.extend(HibernatingItem0)
+        else
+          @index = i0
+          r0 = nil
+        end
+
+        node_cache[:HibernatingItem][start_index] = r0
+
+        r0
+      end
+
+    end
+
+    class RouterDescriptorParser < Treetop::Runtime::CompiledParser
+      include RouterDescriptor
+    end
+
+  end
+end