georgboe-ucli 0.2.0

data/README.md

@@ -0,0 +1,126 @@
+## ucli
+
+ Ucli is a simple commandline interface against uTorrent's WebUI.
+
+### Requirements
+* curl
+* trollop >= 1.10 (gem)
+* json (gem)
+
+### Getting started
+
+Ucli uses a yaml file to store your configuration. An examplefile will be generated at first run.
+
+	~% ucli                       
+	No config file found.
+	Check out ~/.ucli_config.yml.example
+
+Now edit this configuration file with your information and rename it to `.ucli_config.yml`.
+You are now ready to use the commands.
+
+### Usage
+
+#### List all torrents
+
+Running the command `ucli --list` or `ucli -l` will give you a list of all the torrents in utorrent.
+The output will look like this:
+
+    +-----------------------------------------------------------+----------+-------+
+    | Torrentname                                               | Uploaded | Ratio |
+    +-----------------------------------------------------------+----------+-------+
+    | ubuntu-8.10-desktop-i386.iso                              |   1.24 GB|   1.82|
+    | *ubuntu-8.10-server-i386.iso*                             |   0.00 KB|   0.00|
+    +-----------------------------------------------------------+----------+-------+
+
+The stars surrounding the last torrent means that the downloading has not completed yet.
+
+#### Uploading torrents
+
+You can upload torrents from your local machine to the webui the `ucli -u` command.
+A label/category is required for all torrents.
+
+    ucli -u *.torrent -c "MISC"
+
+The command above will upload all torrent files in your current working directory and
+add the label "MISC" all of them.
+
+#### Remove torrents
+
+You can remove torrents with the `ucli -r` command.
+You can specify a name or regex to match.   
+It will show you all the matches along with their shareratio and will not delete anything before you have confirmed it.
+
+    ~% ucli -r server
+    Found the following torrents
+    ============================
+    ubuntu-8.10-server-i386.iso (0.06)
+
+    Are you sure you want to remove these torrents? (y or n): 
+
+In this case there was only on matching torrent, but you can remove large amount of torrents using regexes.
+
+#### Removing old tv episodes
+
+`ucli --oldepisodes` looks for torrents of the same tv show. If you have two episode of the same show, it will suggest remove the oldest.
+Let's say you have these episodes in uTorrent:
+
+    Tvshow.S01E01.HDTV-XviD-GROUP
+    Tvshow.S01E02.HDTV-XviD-GROUP
+    
+    Another.show.S02E04.HDTV-XviD-GROUP
+    Another.show.S02E12.HDTV-XviD-GROUP
+
+Now we try to run the command.
+
+    ~% ucli --oldepisodes
+    Found the following old episodes
+    ================================
+    Tvshow.S01E01.HDTV-XviD-GROUP (1.49)
+    Another.show.S02E04.HDTV-XviD-GROUP (1.20)
+
+    Do you want to remove them? (y or n):
+
+#### Listing files in torrents
+
+`ucli --ls` command will show you all the files with filesizes in the torrents matching you input.
+
+    ~% ucli --ls server
+    ubuntu-8.10-server-i386.iso
+    ===========================
+    ubuntu-8.10-server-i386.iso (637.32 MB)
+    
+
+### Notes
+
+* I have not tried this script on Windows, and I don't think uploading torrents will work. This is due to the difference in the way windows passes arguments to programs as opposed to unix/linux. The other functionality shouldn't be a problem though.
+
+* This application was made to work with uTorrent WebUI 0.361. It will not work with earlier version, but probably will work with later versions.
+
+* You can actually use a regex for all the options that requires input to match a torrent. `ucli -r "\d\d"` will remove all torrents containing two digits.
+
+[More information about the Web UI API](http://forum.utorrent.com/viewtopic.php?id=25661#p258858 "Web UI API on the uTorrent forum")
+
+### LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Georg Alexander Bøe
+
+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,48 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+require 'rake/gempackagetask'
+ 
+GEM = "ucli"
+GEM_VERSION = "0.2.0"
+SUMMARY = "Commandline interface to uTorrent WebUI 0.361"
+AUTHOR = "Georg Alexander Bøe"
+EMAIL = "georg.boe@gmail.com"
+
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.require_paths = ['lib']
+  s.files = ['README.md', 'Rakefile'] + Dir["{lib,bin,spec}/**/*"]
+  s.bindir = 'bin'
+  s.executables = ['ucli']
+  
+  s.author = AUTHOR
+  s.email = EMAIL
+  
+  s.add_dependency 'json'
+  s.add_dependency 'trollop', '>=1.10'
+
+  s.rubyforge_project = GEM # GitHub bug, gem isn't being build when this miss
+end
+
+  
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/bin/ucli

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+
+require 'open-uri'
+require 'json'
+require 'yaml'
+require 'trollop'
+require 'ostruct'
+
+require 'lsfile.rb'
+require 'torrent.rb'
+require 'utilities.rb'
+
+PROGRAM_VERSION = '0.2.0'
+
+begin
+  
+  file = YAML.load_file(File.expand_path('~/.ucli_config.yml'))
+  @@settings = OpenStruct.new(file)
+rescue Exception => e
+  STDERR.puts "No config file found.\nCheck out ~/.ucli_config.yml.example"
+  open(File.expand_path('~/.ucli_config.yml.example'), 'w+') do |file|
+    file.puts "
+# rename this file to '.ucli_config.yml'
+host: ipadrress_or_hostname
+port: 8080
+username: your_username
+password: your_password
+  ".strip
+  end
+  exit 1
+end
+
+opts = Trollop::options do
+  version "utorrent version #{PROGRAM_VERSION}"
+  opt :list, "List all torrents"
+  opt :upload, "Uploads the given torrentfiles", :type => :ios
+  opt :category, "Category for uploaded file", :type => :string, :default => nil
+  opt :oldepisodes, "Show and remove old tv episodes"
+  opt :remove, "Remove torrents by name", :type => :strings
+  opt :ls, "Show files for a given torrent", :type => :string
+end
+
+Trollop.die("No option selected") unless opts[:list] or opts[:upload] or opts[:download] or opts[:oldepisodes] or opts[:remove] or opts[:ls]
+Trollop.die("Category is required for uploaded torrent") if opts[:upload] and !opts[:category]
+
+if opts[:list]
+  # Textmate & DTerm tput hack
+  if `echo $TERM` == "dumb\n"
+    TORRENTNAME_WIDTH = 58
+  else
+    TORRENTNAME_WIDTH = (`tput cols`.to_i != 0 ? (`tput cols`.to_i) - 22 : 58)
+  end
+  
+  Utilities.print_separator(TORRENTNAME_WIDTH)
+  puts "| #{'Torrentname'.ljust(TORRENTNAME_WIDTH)}|#{'Uploaded'.center(10)}|#{'Ratio'.center(7)}|"
+  Utilities.print_separator(TORRENTNAME_WIDTH)
+  Torrent.all.sort { |x,y| x.name <=> y.name }.each { |x| x.name = "*#{x.name}*" unless x.done == 100.0 }.each do |torrent|
+    puts "| #{Utilities.cut_string(torrent.name, TORRENTNAME_WIDTH).ljust(TORRENTNAME_WIDTH)}|#{torrent.uploaded.to_s.rjust(10)}|#{torrent.ratio.to_s.rjust(7)}|"
+  end
+  Utilities.print_separator(TORRENTNAME_WIDTH)
+  
+elsif opts[:upload]
+  
+  opts[:upload].each do |torrent|
+    
+    path = File.expand_path(torrent.path)
+    result = Torrent.upload_torrent(path, opts[:category])
+
+    if result
+      puts "#{File.basename(path)} successfully uploaded."
+    else
+      puts "Uploading torrent failed."
+    end
+  end
+  
+  delete = Utilities.agree?("Do you want to delete the .torrent files?")
+  if delete
+    opts[:upload].each do |e|
+      path = File.expand_path(e.path)
+      File.delete(path)
+      puts "#{File.basename(path)} deleted."
+    end
+  end
+  
+elsif opts[:oldepisodes]
+  old_episodes = Torrent.find_old_episodes
+  
+  if (old_episodes.length == 0)
+     puts "No old episodes found."
+     exit 0
+  end
+  
+  puts "Found the following old episodes"
+  puts "================================"
+  old_episodes.each { |episode| puts "#{episode.name} (#{episode.ratio})" }
+  puts
+  should_remove = Utilities.agree?("Do you want to remove them?")
+
+  if should_remove
+    old_episodes.each do |e|
+      e.remove
+    end
+    puts "Old episodes removed."
+  end
+  
+elsif opts[:remove]
+  torrents = opts[:remove].inject([]) { |sum, x| sum += Torrent.find_by_name(x) }
+  
+  if torrents.length == 0
+    puts "No torrents mached #{opts[:remove]}"
+    exit 1
+  end
+    
+  puts "Found the following torrents"
+  puts "============================"
+  torrents.each { |torrent| puts "#{torrent.name} (#{torrent.ratio})" }
+  puts
+  should_remove = Utilities.agree?("Are you sure you want to remove these torrents?")
+      
+  if should_remove
+    torrents.each do |torrent|
+      torrent.remove
+      puts "#{torrent.name} removed."
+    end
+  end
+
+elsif opts[:ls]
+  torrents = Torrent.find_by_name(opts[:ls])
+  
+  if torrents.length == 0
+    puts "No torrents mached #{opts[:ls]}"
+    exit 1
+  end
+  
+  torrents.each_with_index do |torrent, index|
+    puts if index != 0
+    puts torrent.name
+    puts "=" * torrent.name.length
+    torrent.list_files.each { |file| puts "#{file.name} (#{file.size})" }
+  end
+  
+end

data/lib/lsfile.rb

@@ -0,0 +1 @@
+class LsFile < Struct.new(:name, :size); end

data/lib/torrent.rb

@@ -0,0 +1,110 @@
+class Torrent
+  require 'lsfile.rb'
+  
+  attr_accessor :hash, :name, :uploaded, :ratio, :label, :done, :basename
+  def initialize(hash, name, uploaded, ratio, label, done)
+    @hash = hash
+    @name = name
+    @uploaded = uploaded
+    @ratio = ratio
+    @done = done
+    @label = label
+  end
+  
+  def set_category(category)
+    open("http://#{@@settings.host}:#{@@settings.port}/gui/?action=setprops&s=label&hash=#{@hash}&v=#{category}", :http_basic_authentication => [@@settings.username, @@settings.password])
+  end
+  
+  def remove
+    template = "http://#{@@settings.host}:#{@@settings.port}/gui/?action=remove&hash=%s"
+    open(template % @hash, :http_basic_authentication => [@@settings.username, @@settings.password]) {|f| f.read }
+  end
+  
+  def self.all
+    json = JSON.parse(open("http://#{@@settings.host}:#{@@settings.port}/gui/?list=1", :http_basic_authentication => [@@settings.username, @@settings.password]).read)
+    torrents = Array.new
+
+    json['torrents'].each do |item|
+      torrents << Torrent.new(item[0], item[2], format_size(item[6].to_i), format_ratio(item[7]), item[11], (item[4].to_f / 10.00))
+    end
+    torrents
+  end
+  
+  def self.upload_torrent(file, category=nil)
+    result = system("curl --basic --user #{@@settings.username}:#{@@settings.password} -F \"torrent_file=@#{file};type=application/x-bittorrent\" 'http://#{@@settings.host}:#{@@settings.port}/gui/?action=add-file' &> /dev/null")
+
+    if result and category
+      Torrent.all.last.set_category(category)
+    end
+  end
+  
+  def self.find_old_episodes
+
+    episodes = all.reject {|x| !x.name.match(/(S\d+(\.|)E\d+)|(\d+x\d+)/)}
+    old_episodes = Array.new
+
+    episodes.each { |e| e.basename = e.name.gsub(/(.+)(\.S\d+(\.|)E\d+|\d+x\d+).+/, '\1')}.sort! {|x,y| x.name <=> y.name }
+
+    duplicates = Hash.new
+
+    episodes.each { |e|
+      if duplicates.has_key?(e.basename)
+        duplicates[e.basename] += 1
+      else
+        duplicates[e.basename] = 1
+      end
+    }
+
+    duplicates.reject { |k,v| v == 1 }
+
+    episodes.each_with_index do |episode, i|
+
+      if !duplicates.has_key?(episode.basename)
+        next
+      end
+
+      next if i == episodes.length-1
+
+      old_episodes << episode unless episodes[i+1].basename != episode.basename
+    end
+
+    old_episodes
+  end
+  
+  def self.find_by_name(name)
+    torrents = Array.new
+    all.each { |torrent| torrents << torrent if torrent.name =~ Regexp.new(name, true)}
+    torrents
+  end
+  
+  def list_files
+    json = JSON.parse(open("http://#{@@settings.host}:#{@@settings.port}/gui/?action=getfiles&hash=#{@hash}", :http_basic_authentication => [@@settings.username, @@settings.password]).read)
+    files = Array.new
+    json['files'][1].each { |file| files << LsFile.new(file[0], Torrent.format_size(file[1]))}
+    files
+  end
+  
+  private
+  
+  def self.format_size(bytes)
+
+    bytes = bytes.to_f
+
+    if bytes > 1024**3
+      return "%1.2f GB" % (bytes / 1024**3)
+    elsif bytes > 1024**2       
+      return "%1.2f MB" % (bytes / 1024**2)
+    else
+      return "%1.2f KB" % (bytes / 1024)
+
+    end
+    
+  end
+
+  def self.format_ratio(ratio)
+    return "0.00" if ratio.to_s.length == 1
+
+    "%0.2f" % (ratio.to_f / 1000.00)
+  end
+  
+end

data/lib/utilities.rb

@@ -0,0 +1,34 @@
+class Utilities
+  
+  def self.cut_string(string, length=58)
+    if string.length > length-1
+      string = string[0,length-4] + '...'
+    end
+    string
+  end
+
+  def self.print_separator(length=58)
+    puts "+" + ("-" * length) + "-+----------+-------+"
+  end
+
+  def self.agree?(message)
+    valid = false
+    answer = false
+
+    while (!valid) do
+
+      print "#{message} (y or n): "
+      line = gets.strip
+
+      if (line.downcase == 'y')
+        valid = true
+        answer = true
+      elsif (line.downcase == 'n')
+       valid = true
+       answer = false
+      end
+    end
+    answer
+  end
+  
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: georgboe-ucli
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- "Georg Alexander B\xC3\xB8e"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-14 00:00:00 -07:00
+default_executable: ucli
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.10"
+    version: 
+description: 
+email: georg.boe@gmail.com
+executables: 
+- ucli
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/lsfile.rb
+- lib/torrent.rb
+- lib/utilities.rb
+- bin/ucli
+has_rdoc: false
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+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: ucli
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Commandline interface to uTorrent WebUI 0.361
+test_files: []
+