mktorrent 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2c1e1c11c1f953694f5c37137f7bae096fcafef
-  data.tar.gz: ba510aa5d85d4d5ae56a1dd603e3e218d408d156
+  metadata.gz: 5d4731c3daab47190d6c9e8bb7ab4a3e6c2969da
+  data.tar.gz: bb119f7dbab44825092c5662c3b72764cd4c0b96
 SHA512:
-  metadata.gz: 27a025b8b1f7c17ac729610e5b85a4c41d84d4224f510738bfa32fa04277b82aaa37fb8d01bf102b339d27a9f76e815f5aa4fca9e3b22f847e30aed317fd111d
-  data.tar.gz: e3a661b103900c77446bda96cb45371462eea67094f681f277298854a919f7e1082a45c213c4711a68c20f7a45ea0811c976088ffa0ca39fd977fb039eb1bffd
+  metadata.gz: 8a6af671931fa2fc18678567a748890e59513c75f901db964fb4c440b1981205cb658ad776a5f7e537a7e30d1c81a0a82d85e1439c7b345a901be1aba7a88410
+  data.tar.gz: 775bd09318ccf12386317b6dc31225f95d4f621cb2ee6e05361961e450ee8ff1b11d509f9a90272ac791497d1659df08f6d733510232b20bccd6cc121fa69bc6

data/lib/mktorrent.rb

@@ -1,17 +1,16 @@
 require 'bencode'
 require 'digest/sha1'
 require 'date'
+require 'uri'
 
 # Sample usage
 #t = Torrent.new("http://your.tracker.com")
 #t.add_file("path/to/file.foo")
 #t.write_torrent("~/Downloads/mytorrent.torrent")
 
-# TODO
-# Support tracker-list
-
 class Torrent
-  attr_accessor :info, :filehashes, :piecelength, :files, :defaultdir, :tracker, :size, :privacy
+  attr_reader :torrent_file
+  attr_accessor :info, :filehashes, :piecelength, :files, :defaultdir, :tracker, :size, :privacy, :webseeds
 
   # optionally initialize filename
   def initialize(tracker)
@@ -22,17 +21,15 @@ class Torrent
     @size = 0
     @defaultdir = "torrent"
     @privacy = 0
+    @webseeds = []
+    @dirbase = ""
     build_the_torrent
   end
 
   def all_files
     unless @files.count < 1
-      all_files = []
-      @files.each do |f|
-        all_files << f[:path]
-      end
+      @files.collect { |file| file[:path] }
     end
-    all_files
   end
 
   def count
@@ -42,13 +39,13 @@ class Torrent
   def read_pieces(files, length)
     buffer = ""
     files.each do |f|
-      puts "hashing #{f.join("/")}"
-      File.open(f.join("/")) do |fh|
+      f = File.join(@dirbase, f) unless @dirbase.empty?
+      File.open(f) do |fh|
         begin
           read = fh.read(length - buffer.length)
 
           # Make sure file not empty
-          if not read.nil?
+          unless read.nil?
             if (buffer.length + read.length) == length
               yield(buffer + read)
               buffer = ""
@@ -64,35 +61,34 @@ class Torrent
   end
 
   def build
-    @info = { :announce => @tracker,
-              :'creation date' => DateTime.now.strftime("%s"),
-              :info => { :name => @defaultdir,
-                         :'piece length' => @piecelength,
-                         :files => @files,
-                         :private => @privacy
-                       }
-            }
+    @info = {
+      :announce => @tracker,
+      :'creation date' => DateTime.now.strftime("%s"),
+      :info => {
+        :name => @defaultdir,
+        :'piece length' => @piecelength,
+        :files => @files,
+        :private => @privacy,
+      }
+    }
     @info[:info][:pieces] = ""
+    @info[:url-list] = @webseeds if @webseeds.any?
     if @files.count > 0
       i = 0
       read_pieces(all_files, @piecelength) do |piece|
         @info[:info][:pieces] += Digest::SHA1.digest(piece)
         i += 1
-        if (i % 100) == 0
-          #print "#{(i.to_f / num_pieces * 100.0).round}%... "; $stdout.flush
-        end
       end
     end
   end
 
   def write_torrent(filename)
     build_the_torrent
-    open(filename, 'wb') do |torrentfile|
-      torrentfile.write self.to_s
+    @torrent_file = File.absolute_path(filename)
+    open(@torrent_file, 'wb') do |file|
+      file.write self.to_s
     end
-    torrent_file = "#{`pwd`.chomp}/#{filename}"
-    puts "Wrote #{torrent_file}"
-    torrent_file
+    @torrent_file
   end
 
   # Return the .torrent file as a string
@@ -103,45 +99,50 @@ class Torrent
   end
 
   def add_file(filepath)
-    if((@files.select { |f| f[:path].join('/') == filepath } ).count > 0)
+    path_for_torrent = path_for_torrent_from_file(filepath)
+
+    if((@files.select { |f| f[:path] == path_for_torrent } ).count > 0)
       raise IOError, "Can't add duplicate file #{File.basename(filepath)}"
     end
 
+    # Remove a leading slash
+    if ( ! @dirbase.empty?) && filepath[0] == '/'
+      filepath = filepath.slice(1, filepath.length)
+    end
+
     if File.exist?(filepath)
-      #filesize = hash_pieces(filepath)
-      # TODO tidy the path up...
-      @files << { path: filepath.split('/'), length: File::open(filepath, "rb").size }
+      @files << { path: path_for_torrent, length: File::open(filepath, "rb").size }
+    elsif @dirbase && File.exist?(File.join(@dirbase, filepath))
+      @files << { path: path_for_torrent, length: File::open(File.join(@dirbase, filepath), "rb").size }
     else
       raise IOError, "Couldn't access #{filepath}"
     end
   end
 
   def add_directory(path)
+    path = Pathname.new(path)
+    @dirbase = File.dirname(path) unless path.relative?
+    add_directory_to_torrent(path)
+  end
+
+  def add_directory_to_torrent(path)
     # Using Dir.entries instead of glob so that non-escaped paths can be used
     Dir.entries(path).each do |entry|
       # Ignore unix current and parent directories
       next if entry == '.' or entry == '..'
 
-      filename = path + File::SEPARATOR + entry
+      filename = File.join(path, entry).gsub(@dirbase, '') # Add a relative path
       if File.directory?(filename)
-        add_directory(filename)
-      else 
+        add_directory_to_torrent(filename)
+      else
         add_file(filename)
       end
     end
   end
 
-  # Need to read the files in @piecelength chunks and hash against that
-  def hash_pieces(files)
-    offset = 0
-    f = File::open(file, "rb")
-    @size += f.size
-    while offset < f.size do
-      offset += @piecelength
-      STDOUT.write "\r#{File.basename(file)}: hashed #{(offset.to_f / f.size.to_f)*100}%"
-      STDOUT.flush
-    end
-    return f.size
+  def add_webseed(url)
+    validate_url!(url)
+    webseeds << url unless webseeds.include?(url)
   end
 
   def set_private
@@ -153,4 +154,23 @@ class Torrent
   end
 
   alias build_the_torrent build
+
+  private
+    def validate_url!(url)
+      u = URI.parse(url)
+      if u.scheme.nil? || u.host.nil?
+        raise ArgumentError.new("#{url} is not a valid URL")
+      end
+    end
+
+    def path_for_torrent_from_file(filepath)
+      unless @dirbase.empty?
+        filepath = filepath.sub(@dirbase, '')
+      end
+
+      # Remove leading blank item
+      path_for_torrent = filepath.split('/') - [""]
+
+      path_for_torrent
+    end
 end

data/test/mktorrent_acceptance_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+
+# Run an external command against a torrent we generate for validation
+class MktorrentAcceptanceTest < Minitest::Test
+
+  def setup
+    acceptance_command_file = File.open(File.join(File.dirname(__FILE__), 'acceptance_test_command')).read
+    content = acceptance_command_file.split("\n")
+    @command = content.delete_if { |line| line.start_with?("#") || line.strip.empty? }
+    @torrent = create_torrent_for_test
+  end
+
+  def teardown
+    if @torrent && @torrent.torrent_file && File.exist?(@torrent.torrent_file)
+      FileUtils.rm @torrent.torrent_file
+    end
+  end
+
+  def test_the_command_to_run
+    assert_equal 1, @command.count, "Couldn't determine command to run"
+  end
+
+  def test_directory_has_data
+    assert_operator Dir.entries(VALIDPATH).count, :>, 3 # At least one file, include '.' and '..'
+  end
+
+  def test_torrent_passes_acceptance
+    assert File.exist?(@torrent.torrent_file)
+    command = set_validation_command!
+    output = `#{command}`
+    result = $?
+    assert result.success?, "Expected success but was #{result.to_i}. Command run: \n\n#{command}\nOutput: \n\n#{output}"
+  end
+
+  private
+    def create_torrent_for_test
+      torrent = Torrent.new('http://some.tracker.com')
+      torrent.add_directory(VALIDPATH)
+      torrent.write_torrent('torrent_test.torrent')
+      torrent
+    end
+
+    def set_validation_command!
+      @command.first.sub('<TORRENT_FILE>', @torrent.torrent_file).split(' ').shelljoin
+    end
+end

data/test/mktorrent_test.rb

@@ -1,12 +1,6 @@
-require 'minitest/autorun'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'mktorrent')
+require 'test_helper'
 
 class MktorrentTest < Minitest::Test
-  TRACKER = "http://test.example.com"
-  VALIDPATH = File.expand_path("#{File.dirname(__FILE__)}/test_data")
-  VALIDFILEPATH = File.expand_path("#{File.dirname(__FILE__)}/test_data/sample_file1.vhd")
-  VALIDFILE2PATH = File.expand_path("#{File.dirname(__FILE__)}/test_data/sample_file2.vhd")
-  VALIDFILENAME = "randomfile.vhd"
 
   def setup
     @torrent = Torrent.new(TRACKER)
@@ -29,6 +23,12 @@ class MktorrentTest < Minitest::Test
     assert(@torrent.info[:info][:files].select { |f| f[:name] == VALIDFILENAME })
   end
 
+  def test_add_valid_file_as_path_array
+    @torrent.add_file(VALIDFILEPATH)
+    path = @torrent.info[:info][:files].first[:path]
+    assert_kind_of Array, path, "Path should be an array, not #{path}"
+  end
+
   def test_add_another_valid_file
     @torrent.add_file(VALIDFILEPATH)
     @torrent.add_file(VALIDFILE2PATH)
@@ -40,11 +40,17 @@ class MktorrentTest < Minitest::Test
     assert_raises(IOError) { @torrent.add_file(VALIDFILEPATH) }
   end
 
-  def test_add_directory
+  def test_add_directory_increments_file_count
     @torrent.add_directory(VALIDPATH)
     assert_equal 2, @torrent.count
   end
 
+  def test_add_directory_uses_relative_paths
+    assert [ VALIDFILEPATH, VALIDFILE2PATH ].each { |p| p.start_with?(VALIDPATH) }
+    @torrent.add_directory(VALIDPATH)
+    assert @torrent.files.each { |f| ! f[:path].join('/').start_with?(VALIDPATH) }
+  end
+
   def test_default_privacy
      @torrent.add_file(VALIDFILEPATH)
      assert_equal 0, @torrent.privacy
@@ -56,4 +62,15 @@ class MktorrentTest < Minitest::Test
      assert_equal 1, @torrent.privacy
   end
 
+  def test_add_valid_webseed
+    @torrent.add_webseed(WEBSEED)
+    assert_equal 1, @torrent.webseeds.count
+    assert_equal WEBSEED, @torrent.webseeds.first
+  end
+
+  def test_add_invalid_webseed
+    assert_raises(ArgumentError) {
+      @torrent.add_webseed('uheoatnhuetano')
+    }
+  end
 end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/reporters'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'mktorrent')
+Dir.glob('test/support/*.rb').each { |r| load r }
+
+Minitest::Reporters.use! [
+  Minitest::Reporters::DefaultReporter.new(color: true),
+]
+
+
+TRACKER = "http://test.example.com"
+WEBSEED = "http://seed.example.com/webseed"
+VALIDPATH = File.expand_path("#{File.dirname(__FILE__)}/test_data")
+VALIDFILEPATH = File.expand_path("#{File.dirname(__FILE__)}/test_data/sample_file1.vhd")
+VALIDFILE2PATH = File.expand_path("#{File.dirname(__FILE__)}/test_data/sample_file2.vhd")
+VALIDFILENAME = "randomfile.vhd"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mktorrent
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Timothy Mukaibo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bencode
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/mktorrent.rb
+- test/mktorrent_acceptance_test.rb
 - test/mktorrent_test.rb
+- test/test_helper.rb
 homepage: https://github.com/mukaibot/mktorrent
 licenses:
 - MIT
@@ -95,9 +125,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Create .torrent files easily with this gem
 test_files:
+- test/mktorrent_acceptance_test.rb
 - test/mktorrent_test.rb
+- test/test_helper.rb