bencview 0.0.2 → 1.0.0

data/bin/bencview_clean

@@ -1,58 +0,0 @@
-#!/usr/bin/env ruby
-# -*-ruby-*-
-
-require 'bencode'
-require_relative '../lib/bencview/trestle.rb'
-
-include Bencview
-
-$conf = Hash.new
-u = Trestle.new($conf)
-
-$conf[:banner] = "Usage: #{File.basename($0)} [options] file [file ...]"
-$conf[:a] = 'http://tracker.openbittorrent.com/announce'
-
-
-# --[ main ]------------------------------------------------------------
-
-u.config_parse(['foobar']) {|src|
-  o = u.cl_parse(src) # create an OptionParser object
-  o.on('-a STR', 'An announce tracker URL') {|i|
-    $conf[:a] = i
-  }
-  u.cl_parse(src, o) # run cl parser
-}
-
-# print our env
-if $conf[:verbose] >= 2
-  puts 'Libs dir: ' + Trestle.gem_libdir
-  pp $conf
-end
-
-Trestle.errx(1, $conf[:banner]) if ARGV.size == 0
-
-ec = 0
-ARGV.each {|i|
-  begin
-    t = BEncode.load_file i
-  rescue
-    STDERR.puts "#{File.basename i}: #{$!}"
-    ec += 1
-    next
-  end
-
-  t['comment'] = 'Leech without any rating!'
-  t['announce'] = $conf[:a]
-  t['announce-list'] = []
-  
-  out = "" if (out = File.dirname(i) + '/') == "./"
-  out = out + File.basename(i, File.extname(i)) + '.CLEANED' + File.extname(i)
-  u.veputs(1, out)
-  begin
-    open(out, 'w+') {|fp| fp.write(BEncode.dump(t)) }
-  rescue
-    STDERR.puts $!.to_s
-    ec += 1
-  end
-}
-exit ec

data/doc/LICENSE

@@ -1,22 +0,0 @@
-(The MIT License)
-
-Copyright (c) 2010 Alexander Gromnitsky.
-
-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/doc/NEWS.rdoc

@@ -1,11 +0,0 @@
-=== 0.0.2
-
-Fri May  6 00:21:14 EEST 2011
-
-- Minor Rakefile update.
-
-=== 0.0.1
-
-Fri, 31 Dec 2010 10:54:08 +0200
-
-- Created a first skeleton.

data/doc/README.rdoc

@@ -1,9 +0,0 @@
-bencview suite contains several utils to manage .torrent files.
-
-bencview::             Torrent file viewer.
-
-bencview_clean::       Cleans a list of announce trackers & replaces
-                       main announce tracker (to be able to cheat,
-                       for example, http://rutracker.org, ha-ha).
-
-Read about them in corresponding <tt>*.rdoc</tt> files.

data/doc/bencview.rdoc

@@ -1,59 +0,0 @@
-=Name
-
-bencview--torrent file viewer.
-
-
-==Synopsis
-
- bencview [options] file [file ...]
-
-
-==Description
-
-The bencview utility reads torrent files and prints their metadata to
-stdout.
-
-The options are as follows:
-
--d::                        Dump all as raw hash.
-
---config-dirs::             List all possible locations for the
-                            configuration file. The first found wins.
-
---config NAME::             The name of the configuration file. If
-                            it contains <tt>/</tt> in it, the list from
-                            <tt>--config-dirs</tt> is ignored.
-
--V::                        Show version and exit.
-
--v::                        Be more verbose. You can supply it several
-                            times, viz. <tt>-vv</tt> dumps even more
-                            debug info.
-
-==Configuration
-
-bencview looks for its configuration at 3 places at start up.
-
-1. At <tt>BENCVIEW_CONF</tt> env variable.
-   (Its format is exactly similar to CL options.)
-
-2. At the configuration file. Its default name is
-   <tt>bencview.yaml</tt> and it can be stored in several
-   system directories which are observable by <tt>--config--dirs</tt> CL
-   option.
-
-3. At command line.
-
-Higher number levels overrides the values from lower number levels.
-
-The configuration file must be in YAML format. Look into <tt>`gem env
-gemdir`/gems/bencview-x.y.z/etc/</tt> directory for samples.
-
-
-==Examples
-
- % bencview foo.torrent bar.torrent
-
-==See Also
-
-{bencview_clean}[link:doc/bencview_clean_rdoc.html]

data/doc/bencview_clean.rdoc

@@ -1,75 +0,0 @@
-=Name
-
-bencview_clean--cleans a list of announce trackers & replaces main
-announce tracker.
-
-
-==Synopsis
-
- bencview [options] file [file ...]
-
-
-==Description
-
-The bencview_clean utility reads a torrent file and creates a 'cleaner'
-copy of it (with <tt>.CLEANED.torrent</tt> extension) to give you an
-ability to download staff from such idiotic bittorent trackers which
-require 'rating' or other bullshit to participate. (For example, see
-http://rutracker.org)
-
-If a creator of the torrent file has disabled DHT (because he is a
-moron), you will not able to use 'cleaner' version of the torrent
-file. Sorry.
-
-The options are as follows:
-
--a URL::                    An announce tracker URL.
-
---config-dirs::             List all possible locations for the
-                            configuration file. The first found wins.
-
---config NAME::             The name of the configuration file. If
-                            it contains <tt>/</tt> in it, the list from
-                            <tt>--config-dirs</tt> is ignored.
-
--V::                        Show version and exit.
-
--v::                        Be more verbose. You can supply it several
-                            times, viz. <tt>-vv</tt> dumps even more
-                            debug info.
-
-
-==Configuration
-
-bencview_clean looks for its configuration at 3 places at start up.
-
-1. At <tt>BENCVIEW_CONF</tt> env variable.
-   (Its format is exactly similar to CL options.)
-
-2. At the configuration file. Its default name is
-   <tt>bencview.yaml</tt> and it can be stored in several
-   system directories which are observable by <tt>--config--dirs</tt> CL
-   option.
-
-3. At command line.
-
-Higher number levels overrides the values from lower number levels.
-
-The configuration file must be in YAML format. Look into <tt>`gem env
-gemdir`/gems/bencview-x.y.z/etc/</tt> directory for samples.
-
-==Exit Status
-
-The utility exits 0 on success, and >0 if an error occurs. For example,
-if it read 3 files and 2 of them were invalid, the exit status will be 2
-(the number of failures).
-
-==Examples
-
- % bencview_clean foo.torrent bar.torrent
- % bencview_clean -v foobar.torrent
- % bencview_clean -a 'http://tracker.example.org' foobar.torrent
-
-==See Also
-
-{bencview}[link:doc/bencview_rdoc.html]

data/etc/bencview.yaml

@@ -1,2 +0,0 @@
---- 
-:foobar: foobar

data/lib/bencview/meta.rb

@@ -1,9 +0,0 @@
-module Bencview
-  module Meta
-    NAME = 'bencview'
-    VERSION = '0.0.2'
-    AUTHOR = 'Alexander Gromnitsky'
-    EMAIL = 'alexander.gromnitsky@gmail.com'
-    HOMEPAGE = 'http://github.com/gromnitsky/' + NAME
-  end
-end

data/lib/bencview/trestle.rb

@@ -1,216 +0,0 @@
-# :erb:
-require 'yaml'
-require 'shellwords.rb'
-require 'optparse'
-require 'pp'
-require 'open4'
-
-require_relative 'meta'
-
-# :include: ../../README.rdoc
-module Bencview
-
-  class Trestle
-
-    # Execute _cmd_ and return a list [exit_status, stderr,
-    # stdout]. Very handy.
-    def self.cmd_run(cmd)
-      so = sr = ''
-      status = Open4::popen4(cmd) { |pid, stdin, stdout, stderr|
-        so = stdout.read
-        sr = stderr.read
-      }
-      [status.exitstatus, sr, so]
-    end
-
-    # Return a directory with program libraries.
-    def self.gem_libdir
-      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{Bencview::Meta::NAME}",
-           "#{Gem.dir}/gems/#{Bencview::Meta::NAME}-#{Bencview::Meta::VERSION}/lib/#{Bencview::Meta::NAME}",
-           "lib/#{Bencview::Meta::NAME}"]
-      t.each {|i| return i if File.readable?(i) }
-      fail "all paths are invalid: #{t}"
-    end
-
-    # Analogue to shell command +which+.
-    def self.in_path?(file)
-      return true if file =~ %r%\A/% and File.exist? file
-
-      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
-        File.exist? File.join(path, file)
-      end
-    end
-
-    # Print an error message _t_ and exit if _ec_ > 0.
-    def self.errx(ec, t)
-      STDERR.puts File.basename($0) + ' error: ' + t.to_s
-      exit ec if ec > 0
-    end
-
-    # Print a warning.
-    def self.warnx(t)
-      STDERR.puts File.basename($0) + ' warning: ' + t.to_s
-    end
-
-    # #veputs uses this to decide to put a newline or not to put.
-    NNL_MARK = '__NNL__'
-
-    # Use this in your CL options to check if modifying some variable is
-    # not an idempotent act.
-    attr_reader :cl_opt_protect
-
-    # [conf] Typically must be a reference to some global variable.
-    def initialize(conf)
-      @conf = conf
-      @conf[:verbose] = 0
-      @conf[:banner] = "Usage: #{File.basename($0)} [options]"
-      @conf[:config] =  Meta::NAME + '.yaml'
-      @conf[:config_dirs] =  [ENV['HOME']+'/.'+Meta::NAME,
-                              File.absolute_path("#{File.dirname(File.expand_path($0))}/../etc"),
-                              '/usr/etc', '/usr/local/etc', '/etc',
-                              "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/etc"
-                             ]
-      @conf[:config_env] = [Meta::NAME.upcase + '_CONF']
-
-      @cl_parsing_times = 0 # not used
-      @cl_opt_protect = false
-    end
-
-    # [level] A verbose level.
-    # [t]     A string to print.
-    #
-    # Don't print _t_ with a newline if it contains NNL_MARK at the end.
-    def veputs(level, t)
-      t = t.dup
-      nnl = nil
-      if t.match(/#{NNL_MARK}$/)
-        t.sub!(/#{$&}/, '')
-        nnl = 1
-      end
-
-      if @conf[:verbose] >= level
-        nnl ? print(t) : puts(t)
-        STDOUT.flush
-      end
-    end
-    
-    # Run all configuration parsing in a batch.
-    #
-    # [rvars] A list of variable names which must be in the
-    #         configuration file.
-    #
-    # If no block is given, only standard CL options will be analysed.
-    def config_parse(rvars, &block)
-      cb = ->(b, src) {
-        if b
-          block.call src
-        else
-          # very basic default options
-          cl_parse(src, nil, true)
-        end
-      }
-      
-      # 1. parse env
-      @conf[:config_env].each {|i|
-#        puts '0 run:'
-        cb.call(block_given?, ENV[i].shellsplit) if ENV.key?(i)
-      }
-
-      # 2. parse CL in case of '--config' option
-#      puts "\n1 run"
-      @cl_opt_protect = true
-      cb.call(block_given?, ARGV.dup)
-      @cl_opt_protect = false
-
-      # 3. load the configuration file & do the final CL parsing
-      begin
-#        puts "\n2 run"
-        r = config_flat_load(rvars)
-      rescue
-        Trestle.errx(1, "cannot load config: #{$!}")
-      end
-      veputs(1, "Loaded config: #{r}")
-      cb.call(block_given?, ARGV)
-    end
-
-    # Load a config file immediately if it contains '/' in its name,
-    # otherwise search through several dirs for it.
-    #
-    # [rvars] a list of requied variables in the config
-    #
-    # Return a loaded filename or nil on error.
-    def config_flat_load(rvars)
-      p = ->(f) {
-        if File.readable?(f)
-          begin
-            myconf = YAML.load_file(f)
-          rescue
-            abort("cannot parse #{f}: #{$!}")
-          end
-          rvars.each { |i|
-            fail "missing or nil '#{i}' in #{f}" if ! myconf.key?(i.to_sym) || ! myconf[i.to_sym]
-          }
-          @conf.merge!(myconf)
-          return @conf[:config]
-        end
-        return nil
-      }
-
-      if @conf[:config].index('/')
-        return p.call(@config[:config])
-      else
-        @conf[:config_dirs].each {|dir|
-          return dir+'/'+@conf[:config] if p.call(dir + '/' + @conf[:config])
-        }
-      end
-
-      return nil
-    end
-
-
-    # Parses CL-like options.
-    #
-    # [src] An array of options (usually +ARGV+).
-    #
-    # If _o_ is non nil function parses _src_ immediately, otherwise it
-    # only creates +OptionParser+ object and return it (if _simple_ is
-    # false).
-    def cl_parse(src, o = nil, simple = false)
-      if ! o then
-#        puts "NEW o (#{cl_opt_protect})" + src.to_s 
-        o = OptionParser.new
-        o.banner = @conf[:banner]
-        o.on('-v', 'Be more verbose.') { |i|
-#          puts "cl_parsing_times "+cl_parsing_times.to_s
-          @conf[:verbose] += 1 unless cl_opt_protect
-        }
-        o.on('-V', 'Show version & exit.') { |i|
-          puts Meta::VERSION
-          exit 0
-        }
-        o.on('--config NAME', "Set a config name (default is #{@conf[:config]})") {|i|
-          @conf[:config] = i
-        }
-        o.on('--config-dirs', 'Show possible config locations') {
-          @conf[:config_dirs].each { |j|
-            f = j + '/' + @conf[:config]
-            puts (File.readable?(f) ? '* ' : '  ') +  f
-          }
-          exit 0
-        }
-
-        return o if ! simple
-      end
-
-      begin
-        o.parse!(src)
-        @cl_parsing_times += 1
-      rescue
-        Trestle.errx(1, $!.to_s)
-      end
-    end
-    
-  end # trestle
-end
-
-# Don't remove this: falsework/0.2.2/naive/2010-12-26T04:50:00+02:00

data/test/helper.rb

@@ -1,4 +0,0 @@
-# This is supposed to be your helper for all your test. Feel free to
-# add staff here.
-
-require_relative 'helper_trestle'

data/test/helper_trestle.rb

@@ -1,37 +0,0 @@
-# :erb:
-# Various staff for minitest. Include this file into your 'helper.rb'.
-
-require 'fileutils'
-include FileUtils
-
-require_relative '../lib/bencview/trestle'
-include Bencview
-
-# don't run tests automatically if they were invoked as 'gem check -t ...'
-if $0 =~ /gem/
-  require 'minitest/unit'
-else
-  require 'minitest/autorun'
-end
-
-# Return the right directory for (probably executable) _c_.
-def cmd(c)
-  case File.basename(Dir.pwd)
-  when Meta::NAME.downcase
-    # test probably is executed from the Rakefile
-    Dir.chdir('test')
-  when 'test'
-    # we are in the test directory, there is nothing special to do
-  else
-    # tests were invoked by 'gem check -t bencview'
-    begin
-      Dir.chdir(Trestle.gem_libdir + '/../../test')
-    rescue
-      raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
-    end
-  end
-
-  '../bin/' + c
-end
-
-# Don't remove this: falsework/0.2.2/naive/2010-12-26T04:50:00+02:00

data/test/rake_git.rb

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-# -*-ruby-*-
-# :erb:
-
-# This is a helper for your Rakefile. Read the comments for each
-# function.
-
-require 'git'
-require 'pp'
-
-# Return a list of files in a git repository _repdir_.
-#
-# Add this to your gem spec:
-#
-# spec = Gem::Specification.new {|i|
-#   i.files = git_ls('.')
-# }
-#
-# What it does is just collecting the list of the files from the git
-# repository. The idea is to use that list for the gem spec. No more
-# missing or redundant files in gems!
-def git_ls(repdir, ignore_some = true)
-  ignore = ['/?\.gitignore$']
-
-  r = []
-  g = Git.open repdir
-  g.ls_files.each {|i, v|
-    next if ignore_some && ignore.index {|ign| i.match(/#{ign}/) }
-    r << i
-  }
-  r
-end
-
-pp git_ls('.') if __FILE__ == $0
-
-# Don't remove this: falsework/0.2.2/naive/2010-12-26T04:50:00+02:00

data/test/test_bencview.rb

@@ -1,43 +0,0 @@
-require_relative 'helper'
-require 'bencode'
-require 'digest/md5'
-
-class TestBencview_1272419217 < MiniTest::Unit::TestCase
-  CMD = cmd('bencview') # get path to the exe & cd to tests directory
-  
-  def setup
-    # this runs every time before test_*
-  end
-
-  def test_cleaner
-    c = cmd('bencview_clean')
-    r = Trestle.cmd_run "#{c} qwerty asdfgh"
-    assert_equal(2, r[0])
-    assert_match(/No such file or directory/, r[1])
-
-    r = Trestle.cmd_run "#{c} -v torrent/[rutracker.org]2642547.torrent"
-    assert_equal(0, r[0])
-
-    t = BEncode.load_file r[2].strip
-    assert_equal('Leech without any rating!', t['comment'])
-    assert_equal([], t['announce-list'])
-    assert_equal('http://tracker.openbittorrent.com/announce', t['announce'])
-  end
-
-  def test_viewer
-    r = Trestle.cmd_run "#{CMD} qwerty asdfgh"
-    assert_equal(2, r[0])
-    assert_match(/No such file or directory/, r[1])
-
-    r = Trestle.cmd_run "#{CMD} torrent/*.torrent"
-    assert_equal(0, r[0])
-    refute_equal(0, r[2].size)
-
-    r = Trestle.cmd_run "#{CMD} torrent/[rutracker.org]314407.torrent torrent/[rutracker.org].t3128973.torrent"
-    assert_equal(0, r[0])
-    achieved = Digest::MD5.hexdigest(r[2].encode('UTF-8', Encoding.default_external))
-    expected = Digest::MD5.hexdigest(File.read('viewer_output_01.txt').encode('UTF-8', 'KOI8-U'))
-    assert_equal(expected, achieved)
-  end
-  
-end