kieranj-nzb 0.0.1

data/Readme.rdoc

@@ -0,0 +1,21 @@
+= Read Me
+
+Nzb - Ruby library for parsing nzb files
+
+  by Kieran Johnson
+  http://github.com/kieranj/nzb
+
+== Installation:
+
+  $ gem sources -a http://gems.github.com/ (you only need to do this once)
+  $ gem install kieranj-nzb
+
+== Usage:
+
+  require 'rubygems'
+  require 'kieranj-nzb'
+
+  # Parse your file
+  fileset = Nzb.parser(file)
+  
+  # This returns an array of file objects. Each file in turn contains an array of segments. Each segment has the msg_id, number and bytes.

data/history.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2008-10-28
+ 
+* Initial release.

data/lib/nzb.rb

@@ -0,0 +1,44 @@
+%w(rubygems libxml).each { |lib| require lib }
+
+# = Overview:
+# A library for parsing nzb files using libxml for speed
+# ---
+# = License:
+# Author:: Kieran Johnson
+# Copyright:: November, 2008
+# License:: Ruby License
+# ---
+# = Usage:
+#   require 'rubygems'
+#   require 'kieranj-nzb'
+#   
+#   n = Nzb.parse(file) # fileset
+
+class Nzb
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+
+    def self.to_s
+      STRING
+    end
+
+  end
+
+  %w(file segment parser).each do |lib|
+    require ::File.join(::File.dirname(__FILE__), 'nzb', lib)
+  end
+  
+  class << self
+    
+    def parse(file)
+      Parser.new(file).parse
+    end
+  
+  end
+
+end

data/lib/nzb/file.rb

@@ -0,0 +1,28 @@
+class Nzb
+  
+  class File
+    
+    attr_accessor :segments, :groups, :subject
+  
+    def initialize(attrs)
+      @segments = []
+      @groups   = []
+      @subject  = attrs["subject"]
+      @filename = ""
+      @poster   = attrs["poster"]
+      @date     = attrs["date"]
+    end
+    
+    def add_segment(attrs)
+      @segment = Segment.new(attrs)
+      @segments << @segment
+      @segment
+    end
+    
+    def add_group(name)
+      @groups << name
+    end
+    
+  end
+  
+end

data/lib/nzb/parser.rb

@@ -0,0 +1,50 @@
+class Nzb
+  
+  class Parser
+  
+    def initialize(file)
+      @parser           = LibXML::XML::SaxParser.new
+      @parser.file      = file
+      @parser.callbacks = Callbacks.new
+    end
+    
+    def parse
+      @parser.parse
+      @parser.callbacks.files
+    end
+
+    class Callbacks
+      include LibXML::XML::SaxParser::Callbacks
+    
+      attr_reader :files
+    
+      def initialize
+        @files = []
+      end
+      
+      def on_start_element(name, attrs)
+        case name
+        when "file"
+          @files << File.new(attrs)
+        when "segment"
+          @segment = @files.last.add_segment(attrs)
+        when "group"
+          @group = true
+        end
+      end
+          
+      def on_characters(text)
+        if @segment
+          @segment.msgid = text.strip
+          @segment = nil
+        elsif @group
+          @files.last.add_group(text.strip)
+          @group = nil
+        end
+      end
+    
+    end
+
+  end
+  
+end

data/lib/nzb/segment.rb

@@ -0,0 +1,14 @@
+class Nzb
+  
+  class Segment
+    
+    attr_writer :msgid
+    
+    def initialize(attrs)
+      @number = attrs["number"]
+      @bytes  = attrs["bytes"]
+    end
+    
+  end
+  
+end

data/license.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Kieran Johnson
+ 
+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/spec/file_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Nzb
+  
+  describe File do
+    
+  end
+  
+end

data/spec/fixtures/sample.nzb

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="iso-8859-1" ?>
+<!DOCTYPE nzb PUBLIC "-//newzBin//DTD NZB 1.0//EN" "http://www.newzbin.com/DTD/nzb/nzb-1.0.dtd">
+<nzb xmlns="http://www.newzbin.com/DTD/2003/nzb">
+  <file poster="Joe Bloggs &gt;bloggs@nowhere.example&lt;" date="1071674882" subject="Here's your file!  abc-mr2a.r01 (1/2)">
+   <groups>
+     <group>alt.binaries.newzbin</group>
+     <group>alt.binaries.mojo</group>
+   </groups>
+   <segments>
+     <segment bytes="102394" number="1">123456789abcdef@news.newzbin.com</segment>
+     <segment bytes="4501" number="2">987654321fedbca@news.newzbin.com</segment>
+   </segments>
+ </file>
+</nzb>

data/spec/nzb_spec.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/spec_helper'
+  
+describe Nzb do
+
+end

data/spec/parser_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Nzb
+  
+  describe Parser do
+    
+    before do
+      @parser = Parser.new(File.dirname(__FILE__) + "/fixtures/sample.nzb")
+    end
+    
+    it "should return a fileset instance" do
+      fileset = @parser.parse
+      fileset.should be_instance_of(Fileset)
+    end
+    
+  end
+  
+end

data/spec/segment_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Nzb
+  
+  describe Segment do
+    
+    before do
+      attrs = {"msgid" => "123456789abcdef@news.newzbin.com", "bytes" => "102394", "number" => "1"}
+      @segment = Segment.new(attrs)
+    end
+    
+    it "should have the msg_id" do
+      
+    end
+    
+    it "should have the segment number" do
+      
+    end
+    
+    it "should have the message size" do
+      
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: kieranj-nzb
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kieran Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+description: Library for parsing NZB files.
+email: kieran[AT]invisiblelines.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Readme.rdoc
+files: 
+- history.txt
+- license.txt
+- lib/nzb.rb
+- lib/nzb/file.rb
+- lib/nzb/segment.rb
+- lib/nzb/parser.rb
+- README.rdoc
+- Readme.rdoc
+has_rdoc: true
+homepage: http://github.com/kieranj/nzb
+post_install_message: 
+rdoc_options: 
+- --main
+- Readme.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: nzb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A library for parsing nzb files using libxml for speed
+test_files: 
+- spec/fixtures/sample.nzb
+- spec/file_spec.rb
+- spec/segment_spec.rb
+- spec/parser_spec.rb
+- spec/nzb_spec.rb