jphastings-jd-control 1.0.1 → 1.0.2

data/jd-control.rb

@@ -5,6 +5,8 @@
 require 'extensions'
 require 'rubygems'
 require 'httparty'
+require 'tempfile'
+require 'hpricot'
 
 module JDownloader
   # Allows control of JDownloader via the 'Remote Control' plugin
@@ -14,7 +16,7 @@ module JDownloader
     include HTTParty
       
     # The ip address of the computer running JDownloader (probably 127.0.0.1)
-    def initialize(host = "127.0.0.1",port = 5000) # Can't remember the default port!
+    def initialize(host = "127.0.0.1",port = 10025)
       self.class.base_uri "http://#{host}:#{port}/"
     end
     
@@ -55,13 +57,28 @@ module JDownloader
     end
     
     # Creates a new package with the given array of links
-    def download(links)
+    def add_link(links)
       links = [links] if links.is_a?(String)
       self.class.get("/action/add/links/grabber0/start1/"+links.join(" "))
     end
     
+    alias :add_links :add_link
+    
+    # Will add a DLC to the download queue, pass the DLC or a local file
+    def add_dlc(dlc_or_file)
+      if dlc_or_file.is_a?(String)
+        file = Tempfile.open('dlc') do |f|
+          f.write dlc_or_file
+        end
+        dlc_or_file = file.path
+      else
+        raise "That file does not exist" if not File.exists?(dlc_or_file)
+      end
+      self.class.get("/action/add/container/#{dlc_or_file}")
+    end
+    
     # Lists the details of any download or downloads (by id) or all downloads.
-    def download(downloadids = nil)
+    def packages(downloadids = nil)
       downloadids = [downloadids] if downloadids.is_a?(Integer)
       
       dls = parse_packages(self.class.get("/get/downloads/alllist"))
@@ -71,37 +88,39 @@ module JDownloader
         return dls.delete_if {|id, package| not downloadids.include?(id)}
       end
     end
-    alias :downloads :download
+    alias :package :packages
     
     private
     def parse_packages(string)
-      Hash[*string.scan(/<package package_name="(.*?)" package_id="([0-9]+?)" package_percent="([0-9]+?\.[0-9]+?)" package_linksinprogress="([0-9]+?)" package_linkstotal="([0-9]+?)" package_ETA="((?:[0-9]+:)?[0-9]{2}:(?:-1|[0-9]{2}))" package_speed="([0-9]+?) ([G|M|K]B)\/s" package_loaded="([0-9]+?\.?[0-9]*?) ([G|M|K]B)" package_size="([0-9]+?\.[0-9]+?) ([G|M|K]B)" package_todo="([0-9]+?\.?[0-9]*?) ([G|M|K]B)" ?> ?(.*?)<\/package>/).collect { |p|
+      return {} if string.nil?
+      
+      Hash[*Hpricot(string).search("package").collect { |package|
           m = nil
-          [p[1].to_i, Package.new({
-            :name => p[0],
-            :id => p[1].to_i,
+          [package.attributes['package_id'].to_i, Package.new({
+            :name => package.attributes['package_name'],
+            :id => package.attributes['package_id'].to_i,
             :links => {
-              :in_progress => p[3].to_i,
-              :in_total => p[4].to_i
+              :in_progress => package.attributes['package_linksinprogress'].to_i,
+              :in_total => package.attributes['package_linkstotal'].to_i
             },
-            :eta => (p[5] == "00:-1") ? nil : p[5].split(":").reverse.inject(0) { |sum, element| m = ((m.nil?) ? 1 : m*60 ); sum + element.to_i*m },
-            :speed => p[6].to_i * parse_bytes(p[7]),
-            :completed => p[2].to_f/100,
+            :eta => (package.attributes['package_ETA'] == "00:-1") ? nil : package.attributes['package_ETA'].split(":").reverse.inject(0) { |sum, element| m = ((m.nil?) ? 1 : m*60 ); sum + element.to_i*m },
+            :speed => package.attributes['package_speed'].split(" ")[0].to_f * parse_bytes(package.attributes['package_speed'].split(" ")[1]),
+            :completed => package.attributes['package_percent'].to_f/100,
             :size => {
-              :loaded => p[8].to_i * parse_bytes(p[9]),
-              :total => p[10].to_i * parse_bytes(p[11]),
-              :todo => p[12].to_i * parse_bytes(p[13])
+              :loaded => package.attributes['package_loaded'].split(" ")[0].to_f * parse_bytes(package.attributes['package_loaded'].split(" ")[1]),
+              :total => package.attributes['package_size'].split(" ")[0].to_f * parse_bytes(package.attributes['package_size'].split(" ")[1]),
+              :todo => package.attributes['package_todo'].split(" ")[0].to_f * parse_bytes(package.attributes['package_todo'].split(" ")[1])
             },
-            :files => Hash[*p[14].scan(/<file file_name="(.*?)" file_id="([0-9]+?)" file_package="([0-9]+?)" file_percent="([0-9]+?\.[0-9]+?)" file_hoster="(.*?)" file_status="(.*?)" file_speed="(-1|[0-9]+?)" ?>/).collect { |f|
-              [f[1].to_i,{
-                :name => f[0],
-                :id => f[1].to_i,
-                :package_id => f[2].to_i,
-                :completed => f[3].to_f/100,
-                :hoster => f[4],
-                :status => parse_status(f[5]),
-                :speed => (f[6] == "-1") ? nil : f[6].to_i
-              }]
+            :files => Hash[*package.search("file").collect { |file|
+              [file.attributes['file_id'].to_i,JDownloader::File.new({
+                :name => file.attributes['file_name'],
+                :id => file.attributes['file_id'].to_i,
+                #:package_id => file.attributes['file_package'].to_i,
+                :completed => file.attributes['file_percent'].to_f/100,
+                :hoster => file.attributes['file_hoster'],
+                :status => parse_status(file.attributes['file_status']),
+                #:speed => (file.attributes['file_speed'] == "-1") ? nil : file.attributes['file_speed'].to_i
+              })]
             }.flatten]
             
           })]
@@ -111,12 +130,14 @@ module JDownloader
     
     def parse_bytes(bytes)
       case bytes
-      when "GB"
+      when "GB","GB/s"
         return 1048576
-      when "MB"
+      when "MB","MB/s"
         return 1024
-      when "KB"
+      when "KB","KB/s"
         return 1
+      when "B","B/s"
+        return 1/1024
       else
         raise "Unknown unit: #{bytes}"
       end
@@ -128,27 +149,36 @@ module JDownloader
         {
           :description => :finished
         }
-      when /^Wait ([0-9]{2}):([0-9]{2}) min(?:\. for (.+))?$/
+      when /^Wait ([0-9]{2})?:?([0-9]{2}):([0-9]{2}) min(?:\. for (.+))?$/
         {
           :description => :wait,
-          :wait => $3,
-          :time => $1.to_i * 60 + $2.to_i
+          :wait => $4,
+          :time => ETA.new($1.to_i * 3600 + $2.to_i * 60 + $3.to_i)
+        }
+      when "Connecting..."
+        {
+          :description => :wait,
+          :wait => :connecting
         }
       when "[wait for new ip]"
         {
           :description => :wait,
           :wait => :new_ip
         }
-      when /ETA ([0-9]{2}):([0-9]{2}) @ ([0-9]+) ([M|K]B)\/s \([0-9]+\/[0-9]+\)/ # What are these last two digitas? Download slots used and available?
+      when /^ETA ([0-9]{2})?:?([0-9]{2}):([0-9]{2}) @ ([0-9]+\.[0-9]+) ([G|M|K]?B)\/s \(([0-9]+)\/([0-9]+)\)$/ # What are these last two digitas? Download slots used and available?
         {
           :description => :in_progress,
-          :time => $1.to_i * 60 + $2.to_i,
-          :speed => $3.to_i * parse_bytes($4)
+          :time => ETA.new($1.to_i * 3600 + $2.to_i * 60 + $3.to_i),
+          :speed => $4.to_f * parse_bytes($5),
+          :slots => {
+            :used => $6.to_i,
+            :free => $7.to_i - $6.to_i,
+            :total => $7.to_i
+          }
         }
       when ""
         {
-          :description => :wait,
-          :wait => :queued
+          :description => "Unknown"
         }
       else
         status
@@ -156,17 +186,47 @@ module JDownloader
     end
   end
   
+  # JDownloader packages contain files, this class allows interrogation of the files
+  class File
+    attr_reader :name, :id, :hoster, :status, :completed, :speed, :eta
+    def initialize(f)
+      @name = f[:name]
+      @id = f[:id]
+      @hoster = f[:hoster]
+      @status = f[:status]
+      @completed = Percentage.new(f[:completed])
+      @status = {:description => :finished} if @completed == 1
+      @speed = f[:status][:speed] if not f[:status][:speed].nil?
+      @eta = f[:status][:time] if not f[:status][:time].nil?
+    end
+    
+    # Is the file waiting to be downloaded?
+    def waiting?
+      @status[:description] == :wait
+    end
+    
+    # Is the file completed?
+    def finished?
+      @status[:description] == :finished
+    end
+    alias :completed? :finished?
+    
+    def inspect
+      "#{@name}"
+    end
+  end
+  
   # JDownloader packages can be accessed as objects, they're almost totally intuitive
   class Package
-    attr_reader :name, :id, :eta, :speed, :completed, :size, :files
+    attr_reader :name, :id, :eta, :speed, :completed, :size, :files, :status
     def initialize(p)
       @name = p[:name]
       @id = p[:id]
-      @package = p[:package_id]
+      #@package = p[:package_id]
       @eta = (p[:completed] >= 1.0) ? "finished" : (p[:eta].nil?)? "unknown" : ETA.new(p[:eta])
       @speed = p[:speed]
       @completed = Percentage.new(p[:completed])
-      @file = p[:files]
+      @files = p[:files]
     end
     
     def inspect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jphastings-jd-control
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - JP Hastings-Spital
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Control JDownloader from ruby via the 'Remote Control' plugin
 email: jd-control@projects.kedakai.co.uk
 executables: []