nzbget 0.6.0

data/Manifest

@@ -0,0 +1,7 @@
+Manifest
+README.rdoc
+Rakefile
+lib/group.rb
+lib/httparty/request.rb
+lib/nzbget.rb
+nzbget.gemspec

data/README.rdoc

@@ -0,0 +1,50 @@
+== Introduction
+
+This Ruby gem provides a simple means of using NZBGet's RPC interface from within Ruby. It is very lightweight and has minimal dependencies.
+
+NZBGet homepage: http://nzbget.sourceforge.net
+NZBGet is a command-line based binary newsgrabber for nzb files, written in C++. It supports client/server mode, automatic par-check/-repair and web-interface (via additional package). NZBGet requires low system resources and runs great on routers and NAS-devices.
+
+NZBGet RPC: http://nzbget.sourceforge.net/rpc.html
+From the version 0.4.0 NZBGet has supported XML-RPC and JSON-RPC. It allows to control the server from other applications. Many programming languages have libraries, which make the usage of XML-RPC and JSON-RPC very simple. The implementations of both protocols in NZBGet are equal: all methods are identical. You may choose the protocol, which is better supported by your programming language.
+
+== Installation
+
+To install directly from GitHub:
+
+  $ gem sources -a http://gems.github.com # you only need to run this once
+  $ gem install marcbowes-nzbget
+
+== Getting started
+
+  require 'rubygems'
+  require 'nzbget'
+  
+  remote = Nzbget.new :uri => 'http://nzbget-server'
+  puts remote.status
+
+== License
+
+Copyright (c) 2009 Marc Bowes
+
+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,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('nzbget', '0.6.0') do |p|
+  p.description    = "Communicate with NZBGet via RPC."
+  p.url            = "http://github.com/marcbowes/nzbget"
+  p.author         = "Marc Bowes"
+  p.email          = "marcbowes@gmail.com"
+  p.runtime_dependencies = ['httparty']
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/lib/group.rb

@@ -0,0 +1,98 @@
+module NZBGet
+  class Group
+    attr_accessor :attributes
+    
+    def initialize(nzbget, hash)
+      @nzbget     = nzbget
+      @attributes = hash
+    end
+    
+    def category=(category = '')
+      @nzbget.editqueue('GroupSetCategory', 0, category, @attributes['LastID'])
+    end
+    
+    def delete
+      @nzbget.editqueue('GroupDelete', 0, '', @attributes['LastID'])
+    end
+    
+    def downloaded(format = :bytes)
+      formatted_response [size - remaining, 0].max, format
+    end
+    
+    def formatted_response(bytes, format)
+      case format
+      when :bytes, :b      then bytes
+      when :kilobytes, :kb then bytes.to_f / 1024
+      when :megabytes, :mb then bytes.to_f / 1024 ** 2
+      when :gigabytes, :gb then bytes.to_f / 1024 ** 3
+      end
+    end
+    
+    def inspect
+      "#<#{self.class} name=\"#{self.name}\">"
+    end
+    
+    def name
+      @attributes['NZBNicename']
+    end
+    
+    def move(offset_or_sym)
+      return move_to_offset(offset_or_sym) if offset_or_sym.is_a? Fixnum
+      return move_to_symbol(offset_or_sym) if offset_or_sym.is_a? Symbol
+      raise ArgumentError
+    end
+    
+    def percentage
+      (downloaded + paused) * 100.0 / size
+    end
+    
+    def pause(pars = nil)
+      command =
+        unless pars
+          'GroupPause'
+        else
+          if pars == :all
+            'GroupPauseAllPars'
+          elsif pars == :extra
+            'GroupPauseExtraPars'
+          else
+            raise ArgumentError
+          end
+        end
+      
+      @nzbget.editqueue(command, 0, '', @attributes['LastID'])
+    end
+    
+    def paused(format = :bytes)
+      formatted_response @attributes['PausedSizeLo'].to_i, format
+    end
+    
+    def remaining(format = :bytes)
+      formatted_response @attributes['RemainingSizeLo'].to_i, format
+    end
+    
+    def resume
+      @nzbget.editqueue('GroupResume', 0, '', @attributes['LastID'])
+    end
+    
+    def size(format = :bytes)
+      formatted_response @attributes['FileSizeLo'].to_i, format
+    end
+    
+    protected
+    
+      def move_to_offset(offset)
+        @nzbget.editqueue('GroupMoveOffset', offset, '', @attributes['LastID'])
+      end
+    
+      def move_to_symbol(sym)
+        command = case sym
+        when :top       then 'GroupMoveTop'
+        when :bottom    then 'GroupMoveBottom'
+        else raise ArgumentError
+        end
+        
+        @nzbget.editqueue(command, 0, '', @attributes['LastID'])
+      end
+  end
+end

data/lib/httparty/request.rb

@@ -0,0 +1,14 @@
+module HTTParty
+  class Request
+    def uri
+      new_uri = path.relative? ? URI.parse("#{options[:base_uri]}#{path}") : path
+
+      # avoid double query string on redirects [#12]
+      unless @redirect
+        new_uri.query = query_string(new_uri)
+      end
+      new_uri.query = nil if new_uri.query.blank?
+      new_uri
+    end
+  end
+end

data/lib/nzbget.rb

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'httparty'
+require File.join(File.dirname(__FILE__), 'httparty/request')
+require 'group'
+require 'base64'
+
+module NZBGet
+  class RemoteConnection
+    include HTTParty
+    
+    DEFAULT_OPTIONS = {
+      :method   => :json,
+      :password => 'tegbzn6789',
+      :port     => 6789,
+      :uri      => 'http://localhost',
+      :username => 'nzbget'
+    }
+    
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+      
+      uri = URI.parse(@options[:uri])
+      uri.port = @options[:port]
+      
+      self.class.base_uri     uri.to_s
+      self.class.basic_auth   @options[:username], @options[:password]
+      
+      case @options[:method]
+        when :json
+          require 'json'
+        when :xml
+          raise ArgumentError
+        else
+          raise ArgumentError
+      end
+      self.class.format       @options[:method]
+    end
+    
+    def enqueue(path, options = {})
+      extname = File.extname(path)
+      raise ArgumentError unless extname.downcase == '.nzb'
+      
+      filename    = options[:filename] || File.basename(path).sub(/#{extname}$/, '')
+      category    = options[:category] || ''
+      add_to_top  = options[:to_top]   || false
+      
+      content = open(path).read
+      send :append, filename, category, add_to_top, Base64.encode64(content).strip
+    end
+    
+    def paused?
+      send(:status)['result']['ServerPaused']
+    end
+    
+    def groups
+      send(:listgroups)['result'].collect { |g| NZBGet::Group.new(self, g) }
+    end
+    
+    protected
+    
+      def encode(hash)
+        hash.send("to_#{@options[:method].to_s}".to_sym)
+      end
+      
+      def method_missing(name, *args)
+        invoke name, args
+      end
+    
+      def invoke(method, params)
+        #
+        # According to http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html#RequestHeaders:
+        #
+        # Regardless of whether a remote procedure call is made using HTTP GET or POST, the HTTP request message MUST specify the following headers:
+        # * The User-Agent MUST be specified.
+        # * For HTTP POST only, the Content-Type MUST be specified and SHOULD read application/json.
+        # * The Content-Length MUST be specified and correct according to the guidelines and rules laid out in Section 4.4, “Message Length”, of the HTTP specification.
+        # * The Accept MUST be specified and SHOULD read application/json.
+        #
+        # However, NZBGet does not check these headers, so they are not included.
+        #
+        
+        response = self.class.post("/#{@options[:method].to_s}rpc",
+          :body => encode({ :method => method.to_s, :params => params, :version => '1.1' }))
+      end
+      
+  end
+end

data/nzbget.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nzbget}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marc Bowes"]
+  s.date = %q{2009-10-21}
+  s.description = %q{Communicate with NZBGet via RPC.}
+  s.email = %q{marcbowes@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/group.rb", "lib/httparty/request.rb", "lib/nzbget.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/group.rb", "lib/httparty/request.rb", "lib/nzbget.rb", "nzbget.gemspec"]
+  s.homepage = %q{http://github.com/marcbowes/nzbget}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Nzbget", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nzbget}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Communicate with NZBGet via RPC.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: nzbget
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Marc Bowes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Communicate with NZBGet via RPC.
+email: marcbowes@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/group.rb
+- lib/httparty/request.rb
+- lib/nzbget.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- lib/group.rb
+- lib/httparty/request.rb
+- lib/nzbget.rb
+- nzbget.gemspec
+has_rdoc: true
+homepage: http://github.com/marcbowes/nzbget
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Nzbget
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: nzbget
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Communicate with NZBGet via RPC.
+test_files: []
+