RubyGems - sabnzbd - Versions diffs - 0.1.0 → 0.1.1 - Mend

sabnzbd 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/README.rdoc +27 -2
data/VERSION +1 -1
data/fixtures/vcr_cassettes/invalid_key.yml +1 -1
data/fixtures/vcr_cassettes/paused.yml +64 -2
data/fixtures/vcr_cassettes/simple_queue.yml +58 -0
data/fixtures/vcr_cassettes/slots.yml +58 -0
data/lib/sabnzbd.rb +3 -3
data/sabnzbd.gemspec +82 -0
metadata +3 -2

data/README.rdoc CHANGED

@@ -1,6 +1,31 @@
-= sabnzbd
+= Sabnzbd
-Ruby wrapper for the Sabnzbd api.
+    version 0.1.0
+    Daniël Zwijnenburg
+This gem can be used to gather status and download information from your sabnzb instance.
+= Usage
+You can use this gem by including it inside your Gemfile:
+    gem "sabnzbd"
+If you have a running instance of sabnzbd somewhere you will need to get the API key (you can find the API key under config/general > API KEY) and url(defaults to localhost:8080).
+    sab = Sabnzbd.new({api_key: "your_api_key_here"})
+    sab.base_uri
+    => "localhost:8080"
+    sab.paused?
+    => false
+    sab.slots
+     => [#<Sabnzbd::Slot:0x007fb601049638 @time_left="0:00:00", @mb=23749.483629, @msgid="", @filename="a_big_legal_file", @mb_left=22061.784398]
+     sab.slots.first.filename
+     => "a_big_legal_file"
 == Contributing to sabnzbd

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.1.0
1	+ 0.1.1

data/fixtures/vcr_cassettes/invalid_key.yml CHANGED

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://localhost:8080/api?apikey=invalid&mode=qstatus&output=json
+    uri: http://localhost:8080/api?apikey=invalid&limit=LIMIT&mode=queue&output=json&start=START
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/vcr_cassettes/paused.yml CHANGED

@@ -52,8 +52,70 @@ http_interactions:
       - CherryPy/3.2.0
     body:
       encoding: US-ASCII
-      string: ! '{"have_warnings":"7","jobs":[{"timeleft":"0:00:00","mb":23749.483629,"msgid":"","filename":"a_big_legal_file","mbleft":22281.559650,"id":"SABnzbd_nzo_k92LC_"}],"noofslots":1,"paused":true,"pause_int":"0","mbleft":22281.559650,"diskspace2":70.695053,"diskspace1":70.695053,"speed":"0
-        ","timeleft":"0:00:00","mb":23749.483629,"state":"PAUSED","loadavg":"","kbpersec":0.000000}'
+      string: ! '{"queue":{"active_lang":"en","session":"valid_key","slots":[{"status":"Queued","index":0,"eta":"unknown","missing":0,"avg_age":"57d","script":"None","msgid":"","verbosity":"","mb":"23749.48","sizeleft":"13.1
+        GB","filename":"a_big_legal_file","priority":"Normal","cat":"*","mbleft":"13414.81","timeleft":"0:00:00","percentage":"43","nzo_id":"SABnzbd_nzo_k92LC_","unpackopts":"3","size":"23.2
+        GB"}],"speed":"0  ","size":"23.2 GB","limit":0,"start":0,"diskspacetotal2":"232.44","darwin":true,"last_warning":"","have_warnings":"0","noofslots":1,"newzbin_url":"www.newzbin2.es","pause_int":"0","categories":["*","anime","apps","books","consoles","emulation","games","misc","movies","music","pda","resources","tv","unknown"],"diskspacetotal1":"232.44","mb":"23749.48","loadavg":"","cache_max":"0","speedlimit":"","webdir":"/Applications/SABnzbd.app/Contents/Resources/interfaces/Plush/templates","paused":true,"isverbose":false,"restart_req":false,"power_options":true,"helpuri":"http://wiki.sabnzbd.org/","uptime":"4d","refresh_rate":"","version":"0.6.15","color_scheme":"gold","new_release":"0.7.6","nt":false,"status":"Paused","finish":0,"cache_art":"0","paused_all":false,"finishaction":null,"sizeleft":"13.1
+        GB","cache_size":"0 B","mbleft":"13414.81","diskspace2":"62.49","diskspace1":"62.49","scripts":[],"timeleft":"0:00:00","nzb_quota":"","eta":"unknown","kbpersec":"0.00","new_rel_url":"http://sourceforge.net/projects/sabnzbdplus/files/sabnzbdplus/0.7.6/","queue_details":"0"}}'
     http_version:
   recorded_at: Wed, 19 Dec 2012 13:00:12 GMT
+- request:
+    method: get
+    uri: http://localhost:8080/api?apikey=valid_key&mode=qstatus&output=json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Dec 2012 14:48:50 GMT
+      Content-Length:
+      - '425'
+      Content-Type:
+      - application/json;charset=UTF-8
+      Pragma:
+      - no-cache
+      Server:
+      - CherryPy/3.2.0
+    body:
+      encoding: US-ASCII
+      string: ! '{"queue":{"active_lang":"en","session":"valid_key","slots":[{"status":"Queued","index":0,"eta":"unknown","missing":0,"avg_age":"57d","script":"None","msgid":"","verbosity":"","mb":"23749.48","sizeleft":"13.1
+        GB","filename":"a_big_legal_file","priority":"Normal","cat":"*","mbleft":"13414.81","timeleft":"0:00:00","percentage":"43","nzo_id":"SABnzbd_nzo_k92LC_","unpackopts":"3","size":"23.2
+        GB"}],"speed":"0  ","size":"23.2 GB","limit":0,"start":0,"diskspacetotal2":"232.44","darwin":true,"last_warning":"","have_warnings":"0","noofslots":1,"newzbin_url":"www.newzbin2.es","pause_int":"0","categories":["*","anime","apps","books","consoles","emulation","games","misc","movies","music","pda","resources","tv","unknown"],"diskspacetotal1":"232.44","mb":"23749.48","loadavg":"","cache_max":"0","speedlimit":"","webdir":"/Applications/SABnzbd.app/Contents/Resources/interfaces/Plush/templates","paused":true,"isverbose":false,"restart_req":false,"power_options":true,"helpuri":"http://wiki.sabnzbd.org/","uptime":"4d","refresh_rate":"","version":"0.6.15","color_scheme":"gold","new_release":"0.7.6","nt":false,"status":"Paused","finish":0,"cache_art":"0","paused_all":false,"finishaction":null,"sizeleft":"13.1
+        GB","cache_size":"0 B","mbleft":"13414.81","diskspace2":"62.49","diskspace1":"62.49","scripts":[],"timeleft":"0:00:00","nzb_quota":"","eta":"unknown","kbpersec":"0.00","new_rel_url":"http://sourceforge.net/projects/sabnzbdplus/files/sabnzbdplus/0.7.6/","queue_details":"0"}}'
+    http_version:
+  recorded_at: Wed, 19 Dec 2012 14:48:50 GMT
+- request:
+    method: get
+    uri: http://localhost:8080/api?apikey=valid_key&limit=LIMIT&mode=queue&output=json&start=START
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Dec 2012 14:49:03 GMT
+      Content-Length:
+      - '1555'
+      Content-Type:
+      - application/json;charset=UTF-8
+      Pragma:
+      - no-cache
+      Server:
+      - CherryPy/3.2.0
+    body:
+      encoding: US-ASCII
+      string: ! '{"queue":{"active_lang":"en","session":"valid_key","slots":[{"status":"Queued","index":0,"eta":"unknown","missing":0,"avg_age":"57d","script":"None","msgid":"","verbosity":"","mb":"23749.48","sizeleft":"13.1
+        GB","filename":"a_big_legal_file","priority":"Normal","cat":"*","mbleft":"13414.81","timeleft":"0:00:00","percentage":"43","nzo_id":"SABnzbd_nzo_k92LC_","unpackopts":"3","size":"23.2
+        GB"}],"speed":"0  ","size":"23.2 GB","limit":0,"start":0,"diskspacetotal2":"232.44","darwin":true,"last_warning":"","have_warnings":"0","noofslots":1,"newzbin_url":"www.newzbin2.es","pause_int":"0","categories":["*","anime","apps","books","consoles","emulation","games","misc","movies","music","pda","resources","tv","unknown"],"diskspacetotal1":"232.44","mb":"23749.48","loadavg":"","cache_max":"0","speedlimit":"","webdir":"/Applications/SABnzbd.app/Contents/Resources/interfaces/Plush/templates","paused":true,"isverbose":false,"restart_req":false,"power_options":true,"helpuri":"http://wiki.sabnzbd.org/","uptime":"4d","refresh_rate":"","version":"0.6.15","color_scheme":"gold","new_release":"0.7.6","nt":false,"status":"Paused","finish":0,"cache_art":"0","paused_all":false,"finishaction":null,"sizeleft":"13.1
+        GB","cache_size":"0 B","mbleft":"13414.81","diskspace2":"62.49","diskspace1":"62.49","scripts":[],"timeleft":"0:00:00","nzb_quota":"","eta":"unknown","kbpersec":"0.00","new_rel_url":"http://sourceforge.net/projects/sabnzbdplus/files/sabnzbdplus/0.7.6/","queue_details":"0"}}'
+    http_version:
+  recorded_at: Wed, 19 Dec 2012 14:49:03 GMT
 recorded_with: VCR 2.3.0

data/fixtures/vcr_cassettes/simple_queue.yml CHANGED

@@ -56,4 +56,62 @@ http_interactions:
         ","timeleft":"0:00:00","mb":23749.483629,"state":"PAUSED","loadavg":"","kbpersec":0.000000}'
     http_version:
   recorded_at: Wed, 19 Dec 2012 10:34:06 GMT
+- request:
+    method: get
+    uri: http://localhost:8080/api?apikey=valid_key&mode=qstatus&output=json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Dec 2012 14:48:51 GMT
+      Content-Length:
+      - '425'
+      Content-Type:
+      - application/json;charset=UTF-8
+      Pragma:
+      - no-cache
+      Server:
+      - CherryPy/3.2.0
+    body:
+      encoding: US-ASCII
+      string: ! '{"have_warnings":"0","jobs":[{"timeleft":"0:00:00","mb":23749.483629,"msgid":"","filename":"a_big_legal_file","mbleft":13414.808467,"id":"SABnzbd_nzo_k92LC_"}],"noofslots":1,"paused":true,"pause_int":"0","mbleft":13414.808467,"diskspace2":62.491737,"diskspace1":62.491737,"speed":"0
+        ","timeleft":"0:00:00","mb":23749.483629,"state":"PAUSED","loadavg":"","kbpersec":0.000000}'
+    http_version:
+  recorded_at: Wed, 19 Dec 2012 14:48:51 GMT
+- request:
+    method: get
+    uri: http://localhost:8080/api?apikey=valid_key&limit=LIMIT&mode=queue&output=json&start=START
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Dec 2012 14:49:03 GMT
+      Content-Length:
+      - '1555'
+      Content-Type:
+      - application/json;charset=UTF-8
+      Pragma:
+      - no-cache
+      Server:
+      - CherryPy/3.2.0
+    body:
+      encoding: US-ASCII
+      string: ! '{"queue":{"active_lang":"en","session":"valid_key","slots":[{"status":"Queued","index":0,"eta":"unknown","missing":0,"avg_age":"57d","script":"None","msgid":"","verbosity":"","mb":"23749.48","sizeleft":"13.1
+        GB","filename":"a_big_legal_file","priority":"Normal","cat":"*","mbleft":"13414.81","timeleft":"0:00:00","percentage":"43","nzo_id":"SABnzbd_nzo_k92LC_","unpackopts":"3","size":"23.2
+        GB"}],"speed":"0  ","size":"23.2 GB","limit":0,"start":0,"diskspacetotal2":"232.44","darwin":true,"last_warning":"","have_warnings":"0","noofslots":1,"newzbin_url":"www.newzbin2.es","pause_int":"0","categories":["*","anime","apps","books","consoles","emulation","games","misc","movies","music","pda","resources","tv","unknown"],"diskspacetotal1":"232.44","mb":"23749.48","loadavg":"","cache_max":"0","speedlimit":"","webdir":"/Applications/SABnzbd.app/Contents/Resources/interfaces/Plush/templates","paused":true,"isverbose":false,"restart_req":false,"power_options":true,"helpuri":"http://wiki.sabnzbd.org/","uptime":"4d","refresh_rate":"","version":"0.6.15","color_scheme":"gold","new_release":"0.7.6","nt":false,"status":"Paused","finish":0,"cache_art":"0","paused_all":false,"finishaction":null,"sizeleft":"13.1
+        GB","cache_size":"0 B","mbleft":"13414.81","diskspace2":"62.49","diskspace1":"62.49","scripts":[],"timeleft":"0:00:00","nzb_quota":"","eta":"unknown","kbpersec":"0.00","new_rel_url":"http://sourceforge.net/projects/sabnzbdplus/files/sabnzbdplus/0.7.6/","queue_details":"0"}}'
+    http_version:
+  recorded_at: Wed, 19 Dec 2012 14:49:03 GMT
 recorded_with: VCR 2.3.0

data/fixtures/vcr_cassettes/slots.yml CHANGED

@@ -28,4 +28,62 @@ http_interactions:
         ","timeleft":"0:00:00","mb":23749.483629,"state":"PAUSED","loadavg":"","kbpersec":0.000000}'
     http_version:
   recorded_at: Wed, 19 Dec 2012 12:58:36 GMT
+- request:
+    method: get
+    uri: http://localhost:8080/api?apikey=valid_key&mode=qstatus&output=json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Dec 2012 14:48:51 GMT
+      Content-Length:
+      - '425'
+      Content-Type:
+      - application/json;charset=UTF-8
+      Pragma:
+      - no-cache
+      Server:
+      - CherryPy/3.2.0
+    body:
+      encoding: US-ASCII
+      string: ! '{"have_warnings":"0","jobs":[{"timeleft":"0:00:00","mb":23749.483629,"msgid":"","filename":"a_big_legal_file","mbleft":13414.808467,"id":"SABnzbd_nzo_k92LC_"}],"noofslots":1,"paused":true,"pause_int":"0","mbleft":13414.808467,"diskspace2":62.491737,"diskspace1":62.491737,"speed":"0
+        ","timeleft":"0:00:00","mb":23749.483629,"state":"PAUSED","loadavg":"","kbpersec":0.000000}'
+    http_version:
+  recorded_at: Wed, 19 Dec 2012 14:48:51 GMT
+- request:
+    method: get
+    uri: http://localhost:8080/api?apikey=valid_key&limit=LIMIT&mode=queue&output=json&start=START
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Dec 2012 14:49:03 GMT
+      Content-Length:
+      - '1555'
+      Content-Type:
+      - application/json;charset=UTF-8
+      Pragma:
+      - no-cache
+      Server:
+      - CherryPy/3.2.0
+    body:
+      encoding: US-ASCII
+      string: ! '{"queue":{"active_lang":"en","session":"valid_key","slots":[{"status":"Queued","index":0,"eta":"unknown","missing":0,"avg_age":"57d","script":"None","msgid":"","verbosity":"","mb":"23749.48","sizeleft":"13.1
+        GB","filename":"a_big_legal_file","priority":"Normal","cat":"*","mbleft":"13414.81","timeleft":"0:00:00","percentage":"43","nzo_id":"SABnzbd_nzo_k92LC_","unpackopts":"3","size":"23.2
+        GB"}],"speed":"0  ","size":"23.2 GB","limit":0,"start":0,"diskspacetotal2":"232.44","darwin":true,"last_warning":"","have_warnings":"0","noofslots":1,"newzbin_url":"www.newzbin2.es","pause_int":"0","categories":["*","anime","apps","books","consoles","emulation","games","misc","movies","music","pda","resources","tv","unknown"],"diskspacetotal1":"232.44","mb":"23749.48","loadavg":"","cache_max":"0","speedlimit":"","webdir":"/Applications/SABnzbd.app/Contents/Resources/interfaces/Plush/templates","paused":true,"isverbose":false,"restart_req":false,"power_options":true,"helpuri":"http://wiki.sabnzbd.org/","uptime":"4d","refresh_rate":"","version":"0.6.15","color_scheme":"gold","new_release":"0.7.6","nt":false,"status":"Paused","finish":0,"cache_art":"0","paused_all":false,"finishaction":null,"sizeleft":"13.1
+        GB","cache_size":"0 B","mbleft":"13414.81","diskspace2":"62.49","diskspace1":"62.49","scripts":[],"timeleft":"0:00:00","nzb_quota":"","eta":"unknown","kbpersec":"0.00","new_rel_url":"http://sourceforge.net/projects/sabnzbdplus/files/sabnzbdplus/0.7.6/","queue_details":"0"}}'
+    http_version:
+  recorded_at: Wed, 19 Dec 2012 14:49:03 GMT
 recorded_with: VCR 2.3.0

data/lib/sabnzbd.rb CHANGED

@@ -17,7 +17,7 @@ class Sabnzbd
   end
   def paused?
-    make_request["paused"]
+    make_request["queue"]["paused"]
   end
   def slots
@@ -26,7 +26,7 @@ class Sabnzbd
   private
-  def make_request(url = "/api?mode=qstatus&output=json&apikey=#{@api_key}")
+  def make_request(url = "/api?mode=queue&start=START&limit=LIMIT&output=json&apikey=#{@api_key}")
     verify_response( self.class.get(url).parsed_response )
   end
@@ -37,7 +37,7 @@ class Sabnzbd
   end
   def initialize_slots
-    jobs = make_request["jobs"]
+    jobs = make_request["queue"]["slots"]
     jobs.each.inject([]) do |arr, job|
       arr << Sabnzbd::Slot.new(job)

data/sabnzbd.gemspec ADDED

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = "sabnzbd"
+  s.version = "0.1.1"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Zwijnenburg"]
+  s.date = "2012-12-19"
+  s.description = "Ruby wrapper for the sabnzbd api. This gem can be used to gather status and download information from your sabnzb instance."
+  s.email = "daniel@danielz.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fixtures/vcr_cassettes/invalid_key.yml",
+    "fixtures/vcr_cassettes/paused.yml",
+    "fixtures/vcr_cassettes/simple_queue.yml",
+    "fixtures/vcr_cassettes/slots.yml",
+    "fixtures/vcr_cassettes/valid_key.yml",
+    "lib/sabnzbd.rb",
+    "lib/sabnzbd/slot.rb",
+    "sabnzbd.gemspec",
+    "spec/sabnzbd_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/DanielZwijnenburg/sabnzbd"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Ruby wrapper for the sabnzbd api."
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.8.0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<autotest-growl>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<webmock>, ["~> 1.8.0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<autotest-growl>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<webmock>, ["~> 1.8.0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<autotest-growl>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sabnzbd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease:
 platform: ruby
 authors:
@@ -180,6 +180,7 @@ files:
 - fixtures/vcr_cassettes/valid_key.yml
 - lib/sabnzbd.rb
 - lib/sabnzbd/slot.rb
+- sabnzbd.gemspec
 - spec/sabnzbd_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/DanielZwijnenburg/sabnzbd
@@ -197,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3423079978625530037
+      hash: 3295881341766727851
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: