bencview 0.0.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92a0139e1908590118e2d0bd7e0db48b3f8a94e7
+  data.tar.gz: a18f7b361bb9d4dcb5e83f45fd1d0773306db79f
+SHA512:
+  metadata.gz: b8221a19897cc70e617566f8379def9e18fbe1085a4867a0265cf77566c4244383fe60b2d01700bdc99dd3ecbb0fff2ff7d298f8520825384acf081c4c9989a9
+  data.tar.gz: ab6bc66c3b656aa476e673d352e23e8ec1bd1de14008d53799d54d7b7c0bbcdd23abe97bc414f82ac4b116ba48c85fabb5249d944ff04fd63440e374f9b1418a

data/README.md

@@ -0,0 +1,93 @@
+# bencview
+
+`bencview` - a .torrent files viewer for terminal pagers.\
+`json2bencode` - a converter from JSON to the torrent files format.
+
+(Bencode is a data serialization format used by the BitTorrent network.)
+
+## Installation
+
+(Ruby 2.3.0+)
+
+	$ gem install bencview
+
+Add to your `lesspipe.sh`:
+
+<pre>
+case "$1" in
+...
+<b>    *.torrent) bencview "$1" ;;</b>
+...
+esac
+</pre>
+
+Optionally:
+
+	$ npm -g i json
+
+## Usage
+
+View a torrent file:
+
+~~~
+$ bencview gimp.torrent
+infohash: a85b7e7f035c55f684238d0e252b273fe2a1ccf5
+uri: magnet:?xt=urn:btih:a85b7e7f035c55f684238d0e252b273fe2a1ccf5&dn=gimp-2.8.14-setup-1.exe.torrent
+announce: udp://tracker.publicbt.com:80
+announce-list: 2
+ udp://tracker.publicbt.com:80
+ udp://tracker.openbittorrent.com:80
+comment: GIMP 2.8.14 Installer for Microsoft Windows - updated
+created by: mktorrent 1.0
+creation date: Tue, 2 Sep 2014 22:05:50 +0000
+url-list: 34
+ http://gimper.net/downloads/pub/gimp/v2.8/windows
+ http://gimp.afri.cc/pub/gimp/v2.8/windows
+ [...]
+info/name: gimp-2.8.14-setup-1.exe
+info/files: 1
+ 91,931,728 gimp-2.8.14-setup-1.exe
+info/files size: 91,931,728
+~~~
+
+Remove all trackers from it:
+
+~~~
+$ bencview -j gimp.torrent | json -e 'delete this.announce; delete this["announce-list"]' | json2bencode > file.torrent
+
+$ file file.torrent
+file.torrent: BitTorrent file
+
+$ bencview file.torrent
+infohash: a85b7e7f035c55f684238d0e252b273fe2a1ccf5
+uri: magnet:?xt=urn:btih:a85b7e7f035c55f684238d0e252b273fe2a1ccf5&dn=gimp-2.8.14-setup-1.exe.torrent
+comment: GIMP 2.8.14 Installer for Microsoft Windows - updated
+created by: mktorrent 1.0
+creation date: Tue, 2 Sep 2014 22:05:50 +0000
+url-list: 34
+ http://gimper.net/downloads/pub/gimp/v2.8/windows
+ http://gimp.afri.cc/pub/gimp/v2.8/windows
+ [...]
+info/name: gimp-2.8.14-setup-1.exe
+info/files: 1
+ 91,931,728 gimp-2.8.14-setup-1.exe
+info/files size: 91,931,728
+~~~
+
+Note that the infohash hasn't changed.
+
+## History
+
+This is a complete rewrite of the original
+bencview-0.0.x. `bencview_clean` util is gone, for `bencview` can
+export torrent files into JSON.
+
+1.0.0 version is also ~2 times smaller.
+
+## Bugs
+
+* Both utils assume the UTF8 locale.
+
+## License
+
+MIT.

data/bencview

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require_relative './bencview'
+
+opt = {}
+OptionParser.new do |o|
+  o.banner = "Usage: #{File.basename $0} [-jr] [input]"
+  o.on("-j", "Output as JSON") do
+    opt[:json] = true
+  end
+  o.on("-r", "Print as a Ruby hash (debug)") do
+    opt[:raw] = true
+  end
+  o.on('-v', '-V', 'Print the version number') do
+    puts (eval File.read File.join __dir__, 'package.gemspec').version
+    exit
+  end
+end.parse!
+
+io = ARGV.size > 0 ? File.open(ARGV[0]) : $stdin
+torrent = Bencview::Torrent.new io
+
+if opt[:raw]
+  require 'pp'
+  pp torrent.input
+  exit
+end
+
+puts opt[:json] ? torrent.to_json : torrent

data/bencview.rb

@@ -0,0 +1,152 @@
+require 'date'
+require 'digest'
+require 'uri'
+require 'json'
+require "base64"
+
+require 'bencode'
+
+module Bencview
+  # walk through object, firing `block` on each string leaf
+  def self.hash_walk obj, &block
+    if obj.respond_to? :to_hash
+      r = {}
+      obj.to_hash.each do |key, value|
+        r[key] = hash_walk value, &block  # recursion
+      end
+      r
+    elsif obj.respond_to? :to_ary
+      obj.to_ary.map { |a| hash_walk a, &block } # recursion
+    elsif obj.kind_of? String
+      yield obj
+    else
+      obj
+    end
+  end
+end
+
+class Bencview::Torrent
+  attr_reader :input, :infohash
+  def initialize io
+    @input = (BEncode::Parser.new io).parse!
+    raise 'invalid input' unless @input
+    @infohash = sha1
+  end
+
+  def any_to_s obj
+    obj.kind_of?(Array) ? [obj.size, obj].join("\n ").strip : obj.to_s
+  end
+
+  def num n
+    n.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+  end
+
+  # BitTorrent specific
+  def sha1
+    return nil unless @input['info'].kind_of?(Hash)
+    Digest::SHA1.hexdigest @input['info'].bencode
+  end
+
+  # BitTorrent specific
+  def magnet name
+    return nil unless @infohash
+    "magnet:?xt=urn:btih:#{@infohash}" + (name ? "&dn=#{URI.escape name}.torrent" : "")
+  end
+
+  # BitTorrent specific
+  def bti obj, prefix
+    return nil unless obj.kind_of?(Hash)
+
+    rkey = -> key { "#{prefix}#{key}" }
+
+    r = []
+    obj.each do |key,val|
+      key = key.to_s.strip
+      if key =~ /^piece/
+        # TODO: calc the chunks
+      elsif key =~ /\.utf-8$/
+        # ignore
+      elsif key =~ /^(files|length)$/
+        # ignore, but see below `files_add`
+      elsif key == 'profiles' && val.kind_of?(Array)
+        val.each {|item| r.concat to_a item, "#{prefix}#{key}/" }
+      else
+        r.push "#{rkey.call key}: #{val}"
+      end
+    end
+
+    files = []
+    files_add = -> arr do
+      bytes = 0
+      max = 0
+      arr.each do |file|
+        bytes += file['length']
+        max = file['length'] if max < file['length']
+      end
+      max = (num max).size + 1
+
+      files.push "#{rkey.call 'files'}: #{arr.size}"
+      arr.each do |file|
+        files.push "%#{max}s %s" % [num(file['length']), file['path'].join('/')]
+      end
+      files.push "#{rkey.call 'files size'}: #{num bytes}"
+    end
+
+    if obj['files']
+      files_add.call obj['files']
+    elsif obj['length'] && obj['name']
+      files_add.call [{'length' => obj['length'], 'path' => [obj['name']]}]
+    end
+
+    r.concat files if files
+  end
+
+  def to_a obj=nil, prefix=''
+    obj = @input unless obj
+
+    r = []
+    info = nil
+
+    rkey = -> key { "#{prefix}#{key}" }
+
+    if @infohash && prefix == ''
+      r.push "infohash: #{@infohash}"
+      r.push "uri: #{magnet @input.dig 'info', 'name'}"
+    end
+
+    obj.each do |key,val|
+      key = key.to_s.strip
+      if key == 'info'
+        info = bti val, "#{prefix}info/"
+      elsif val.kind_of? Hash
+        r.concat to_a val, "#{prefix}#{key}/" # recursion
+      elsif key =~ /date/
+        r.push "#{rkey.call key}: #{DateTime.strptime(val.to_s, '%s').rfc2822}"
+      elsif key =~ /-list$/
+        r.push "#{rkey.call key}: #{any_to_s val}"
+      else
+        r.push "#{rkey.call key}: #{val}"
+      end
+    end
+
+    r.concat info if info
+    r
+  end
+
+  def to_s obj=nil, prefix=''
+    (to_a obj, prefix).join "\n"
+  end
+
+  # walk through object, return a hash suitable for JSON.stringify
+  def to_json
+    Bencview.hash_walk(@input) do |str|
+      begin
+        str.to_json
+      rescue
+        next Base64.strict_encode64 str
+      end
+      str
+    end.to_json
+  end
+
+end

data/json2bencode

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require_relative './bencview'
+
+io = ARGV.size > 0 ? File.open(ARGV[0]) : $stdin
+print Bencview.hash_walk(JSON.parse io.read) do |str|
+  # check if the string is in base64
+  if str =~ /^([A-Za-z0-9+\/]{4})*([A-Za-z0-9+\/]{4}|[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{2}==)$/
+    next Base64.decode64 str
+  else
+    str
+  end
+end.bencode

data/package.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.version = '1.0.0'
+
+  s.name = 'bencview'
+  s.summary = "View .torrent files; JSON export/import"
+  s.author = 'Alexander Gromnitsky'
+  s.email = 'alexander.gromnitsky@gmail.com'
+  s.homepage = 'https://github.com/gromnitsky/bencview'
+  s.license = 'MIT'
+  s.files = [
+    'bencview',
+    'bencview.rb',
+    'json2bencode',
+    'package.gemspec',
+    'README.md',
+  ]
+
+  s.require_paths = ['.']
+  s.bindir = '.'
+  s.executables = ['bencview', 'json2bencode']
+
+  s.add_runtime_dependency 'bencode', '~> 0.8.2'
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.post_install_message = <<~END
+    *************************************************************************
+    If you were using bencview-0.0.x, please read
+    #{s.homepage},
+    for it's a different program now, totally incompatible w/ 0.0.x releases.
+    *************************************************************************
+  END
+end

metadata

@@ -1,102 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bencview
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Alexander Gromnitsky
 autorequire: 
-bindir: bin
+bindir: "."
 cert_chain: []
-
-date: 2011-04-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: open4
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.1
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+date: 2017-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bencode
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
   type: :runtime
-  version_requirements: *id002
-description: Torrent file viewer & metadata cleaner.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: 
 email: alexander.gromnitsky@gmail.com
-executables: 
-- bencview_clean
+executables:
 - bencview
+- json2bencode
 extensions: []
-
-extra_rdoc_files: 
-- doc/NEWS.rdoc
-- doc/LICENSE
-- doc/bencview.rdoc
-- doc/README.rdoc
-- doc/bencview_clean.rdoc
-files: 
-- README.rdoc
-- Rakefile
-- bin/bencview
-- bin/bencview_clean
-- doc/LICENSE
-- doc/NEWS.rdoc
-- doc/README.rdoc
-- doc/bencview.rdoc
-- doc/bencview_clean.rdoc
-- etc/bencview.yaml
-- lib/bencview/meta.rb
-- lib/bencview/trestle.rb
-- test/helper.rb
-- test/helper_trestle.rb
-- test/rake_git.rb
-- test/test_bencview.rb
-- test/torrent/[rutracker.org].t3128973.torrent
-- test/torrent/[rutracker.org]2642547.torrent
-- test/torrent/[rutracker.org]314407.torrent
-- test/torrent/[rutracker.org]838460.torrent
-- test/torrent/stack overflow data dump - nov 2010.torrent
-- test/viewer_output_01.txt
-homepage: http://github.com/gromnitsky/bencview
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- -m
-- doc/README.rdoc
-require_paths: 
-- lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+extra_rdoc_files: []
+files:
+- "./bencview"
+- "./json2bencode"
+- README.md
+- bencview
+- bencview.rb
+- json2bencode
+- package.gemspec
+homepage: https://github.com/gromnitsky/bencview
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  *************************************************************************
+  If you were using bencview-0.0.x, please read
+  https://github.com/gromnitsky/bencview,
+  for it's a different program now, totally incompatible w/ 0.0.x releases.
+  *************************************************************************
+rdoc_options: []
+require_paths:
+- "."
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.0
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
-summary: Torrent file viewer & metadata cleaner
-test_files: 
-- test/test_bencview.rb
+specification_version: 4
+summary: View .torrent files; JSON export/import
+test_files: []

data/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/Rakefile

@@ -1,50 +0,0 @@
-# -*-ruby-*-
-
-require 'rake'
-require 'rake/gempackagetask'
-require 'rake/clean'
-require 'rake/rdoctask'
-require 'rake/testtask'
-
-require_relative 'lib/bencview/meta'
-include Bencview
-
-require_relative 'test/rake_git'
-
-spec = Gem::Specification.new {|i|
-  i.name = Meta::NAME
-  i.version = `bin/#{i.name} -V`
-  i.summary = 'Torrent file viewer & metadata cleaner'
-  i.description = i.summary + '.' # eat this, freaking rubygems
-  i.author = Meta::AUTHOR
-  i.email = Meta::EMAIL
-  i.homepage = Meta::HOMEPAGE
-  
-  i.platform = Gem::Platform::RUBY
-  i.required_ruby_version = '>= 1.9.2'
-  i.files = git_ls('.')
-
-  i.executables = FileList['bin/*'].gsub(/^bin\//, '')
-  
-  i.test_files = FileList['test/test_*.rb']
-  
-  i.rdoc_options << '-m' << 'doc/README.rdoc'
-  i.extra_rdoc_files = FileList['doc/*']
-
-  i.add_dependency('open4', '>= 1.0.1')
-  i.add_dependency('bencode', '>= 0.6.0')
-}
-
-Rake::GemPackageTask.new(spec).define
-
-task default: [:repackage]
-
-Rake::RDocTask.new('doc') {|i|
-  i.main = 'doc/README.rdoc'
-  i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
-#  i.rdoc_files.exclude("lib/**/some-nasty-staff")
-}
-
-Rake::TestTask.new {|i|
-  i.test_files = FileList['test/test_*.rb']
-}

data/bin/bencview

@@ -1,107 +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[:dump] = false
-
-# Return a string--human redable number, e.g. 123456 becomes '123,456'.
-def dn(n)
-  return n.to_s if n.to_i/1000.0 < 1
-  n.to_s.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
-end
-
-# Convert _s_ from _enc_ to the default external encoding.
-def ds(s, enc)
-  s = s.to_s
-  return s if (enc == Encoding.default_external || enc == "" || !enc)
-  return dn(s) if s.match /^[0-9]+$/
-  s.encode(Encoding.default_external, enc,
-           :undef => :replace,
-           :invalid => :replace)
-end
-
-# Read _s_ as a number of seconds from the Epoch and return a human
-# readable date string.
-def ddate(s)
-  DateTime.strptime(s.to_s, '%s').rfc2822  
-end
-
-# --[ main ]------------------------------------------------------------
-
-u.config_parse(['foobar']) {|src|
-  o = u.cl_parse(src) # create an OptionParser object
-  o.on('-d', 'Dump all as raw hash') {|i| $conf[:dump] = true }
-  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
-visfilesep = ARGV.size > 1 ? "\n" : "" # visual file separator
-ARGV.each {|i|
-  begin
-    t = BEncode.load_file i
-  rescue
-    STDERR.puts "#{File.basename i}: #{$!}"
-    ec += 1
-    next
-  end
-
-  puts visfilesep + 'FILE: ' + File.basename(i)
-  if $conf[:dump]
-    pp t
-    next
-  end
-  enc = t['encoding'].to_s
-
-  t.each {|k,v|
-    case k
-    when "announce-list"
-        puts k + (v.size == 0 ? ':' : ":\n\t" + v.join("\n\t"))
-    when "info"
-      v.each {|info, infoval|
-        case info
-        when /piece/
-          next # a big unredable blob
-        when "files"
-          total = 0
-          puts "files (#{infoval.size}): "
-          
-          biggest = 0
-          infoval.each {|i|
-            biggest = i['length'] if biggest < i['length']
-            total += i['length']
-          }
-          biggest = dn(biggest)
-          
-          infoval.each {|i|
-            printf(" %#{biggest.size}s %s\n",
-                   dn(i['length']), ds(i['path'].join('/'), enc))
-          }
-          puts 'length: ' + dn(total)
-        else
-          puts info + ': ' + ds(infoval, enc)
-        end
-      }
-    when /date/
-      puts k + ': ' + ddate(v)
-    else
-      puts k + ': ' + ds(v, enc)
-    end
-  }
-}
-exit ec