ll-mktorrent 1.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b226f9099a7a0c1a43add68ff6e730b3229c1fb1
+  data.tar.gz: e3c5cb0daf276d661b6f57a044dd31c6a557268a
+SHA512:
+  metadata.gz: 105583b686255b9f09ea34c62f88b2be042fa61da03ff62bce5622d5a2df2fcdbd2007909af8b78763d482dcb93227fde2d9ed628d96fbfe0d5f3f869fd2c67d
+  data.tar.gz: c75b506d907354b9123180150d41b01ad36f268cecbd0443a9ba2695b8a6e8101d060b5678b15a84906865c3b20fd6c2732ce9d1b2f5cc98c37b56ebb48650f4

data/lib/mktorrent.rb

@@ -0,0 +1,266 @@
+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")
+
+class Torrent
+  include Comparable
+
+  attr_reader :torrent_file, :infohash
+  attr_accessor :info, :filehashes, :piecelength, :files, :defaultdir, :tracker, :size, :privacy, :webseed, :tracker_list, :pieces_from_file
+  attr_writer :creation_date, :from_file
+
+  # optionally initialize filename
+  def initialize(tracker, from_file = false)
+    @tracker = tracker
+    @piecelength = 512 * 1024 # 512 KB
+    @files = []
+    @filehashes = []
+    @size = 0
+    @tracker_list = [ [@tracker] ]
+    @defaultdir = "torrent"
+    @privacy = 0
+    @webseed = ""
+    @dirbase = ""
+    @from_file = from_file
+    build_the_torrent
+    yield(self) if block_given?
+  end
+
+  def all_files
+    if @files.any?
+      @files.collect { |file| file[:path] }
+    end
+  end
+
+  def from_file?
+    !!@from_file
+  end
+
+  def count
+    @files.count
+  end
+
+  def creation_date
+    @creation_date ||= DateTime.now.strftime("%s")
+  end
+
+  def path_for_reading_pieces(f)
+    if @dirbase.empty? # it's a single file torrent
+      f = File.join(File.join(f))
+    end
+    f = File.join(@dirbase, f) unless @dirbase.empty?
+    f
+  end
+
+  def read_pieces(files, length)
+    buffer = ""
+    files.each do |file|
+      f = path_for_reading_pieces(file)
+      next if File.directory?(f)
+      File.open(f) do |fh|
+        begin
+          read = fh.read(length - buffer.length)
+
+          # Make sure file not empty
+          unless read.nil?
+            if (buffer.length + read.length) == length
+              yield(buffer + read)
+              buffer = ""
+            else
+              buffer += read
+            end
+          end
+        end until fh.eof?
+      end
+    end
+
+    yield buffer
+  end
+
+  def build
+    @info = {
+      :announce => @tracker,
+      :'announce-list' => @tracker_list,
+      :'creation date' => creation_date,
+      :info => {
+        :name => @defaultdir,
+        :'piece length' => @piecelength,
+        :files => @files,
+        :private => @privacy,
+      }
+    }
+    @info[:info][:pieces] = ""
+    @info.merge!({ :'url-list' => @webseed }) if @webseed
+    if @files.count > 0
+      if from_file?
+        @info[:info][:pieces] = pieces_from_file
+      else
+        read_pieces(all_files, @piecelength) do |piece|
+          @info[:info][:pieces] += Digest::SHA1.digest(piece)
+        end
+      end
+    end
+    set_infohash
+  end
+
+  def self.from_file(filename)
+    data = data_from_file(filename)
+
+    to = new(data['announce'], true ) do |t|
+      t.tracker_list = data['announce-list']
+      t.creation_date = data['creation date']
+      t.defaultdir = data['info']['name']
+      t.piecelength = data['info']['piece length']
+      t.files = data['info']['files']
+      t.privacy = data['info']['private']
+      t.webseed = data['url-list']
+      t.pieces_from_file = data['info']['pieces']
+      t.build
+    end
+
+    yield to if block_given?
+    to
+  end
+
+  def self.data_from_file(filename)
+    torrent_file = File.absolute_path(filename)
+    data = nil
+    File.open(torrent_file, 'rb') do |f|
+      data = BEncode.load(StringIO.new f.read)
+    end
+    raise unless data
+    data
+  end
+
+  def write(filename)
+    build_the_torrent
+    @torrent_file = File.absolute_path(filename)
+    open(@torrent_file, 'wb') do |file|
+      file.write self.to_s
+    end
+  end
+
+  # Return the .torrent file as a string
+  def to_s
+    return "You must add at least one file." if(@files.count < 1)
+    build_the_torrent unless (@info[:info][:files].count == @files.count)
+    @info.bencode
+  end
+
+  def add_file(filepath)
+    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)
+      @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 = File.join(path, entry).gsub(@dirbase, '') # Add a relative path
+      if File.directory?(filename)
+        add_directory_to_torrent(filename)
+      else
+        add_file(filename)
+      end
+    end
+  end
+
+  def set_webseed(url)
+    validate_url!(url)
+    @webseed = url
+  end
+
+  def add_tracker(tracker)
+    @tracker_list << [tracker]
+  end
+
+  def set_private
+    @privacy = 1
+  end
+
+  def set_public
+    @privacy = 0
+  end
+
+  # Implement Comparable. Provides info about whether this torrent
+  # defines the same files as another one.
+  def <=>(obj)
+    build
+    obj.build
+    return -1 if infohash < obj.infohash
+    return 0 if infohash == obj.infohash
+    1
+  rescue StandardError
+    -1
+  end
+
+  # Determine if this matches all the same resources
+  # (including tracker information)
+  def eql?(obj)
+    build
+    obj.build
+    obj.all_info_matches?(@info)
+  rescue StandardError
+    false
+  end
+
+  def all_info_matches?(info)
+    @info.eql?(info)
+  end
+
+  alias build_the_torrent build
+  alias write_torrent write
+
+  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
+
+    def set_infohash
+      @infohash = Digest::SHA1.hexdigest @info[:info].bencode
+    end
+end

data/test/mktorrent_test.rb

@@ -0,0 +1,95 @@
+require 'test_helper'
+
+class MktorrentTest < Minitest::Test
+
+  def setup
+    @torrent = Torrent.new(TRACKER)
+    @torrent2 = Torrent.new(TRACKER)
+    # Lol. This is pretty bad :)
+    fail "Could not find #{VALIDFILEPATH}" unless File.exist? VALIDFILEPATH
+    fail "Could not find #{VALIDFILE2PATH}" unless File.exist? VALIDFILE2PATH
+  end
+
+  def test_create_torrent
+    assert_equal @torrent.tracker, TRACKER
+  end
+
+  def test_add_file_with_invalid_file
+    assert_raises(IOError) { @torrent.add_file("../tmp/bogusfile.vhd") }
+  end
+
+  def test_add_single_valid_file
+    @torrent.add_file(VALIDFILEPATH)
+    assert_equal @torrent.count, 1
+    assert(@torrent.info[:info][:files].select { |f| f[:name] == VALIDFILENAME })
+  end
+
+  def test_add_second_tracker
+    @torrent.add_tracker(SNDTRACKER)
+    assert_equal 2, @torrent.tracker_list.count
+  end
+
+  def test_add_multiple_trackers
+    @torrent.add_tracker(SNDTRACKER)
+    @torrent.add_tracker(THDTRACKER)
+    assert_equal SNDTRACKER, @torrent.tracker_list[1][0]
+  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)
+    assert_equal 2, @torrent.count
+  end
+
+  def test_prevent_duplicate_file_from_being_added
+    @torrent.add_file(VALIDFILEPATH)
+    assert_raises(IOError) { @torrent.add_file(VALIDFILEPATH) }
+  end
+
+  def test_add_directory_increments_file_count
+    @torrent.add_directory(VALIDPATH)
+    assert_equal 3, @torrent.count
+  end
+
+  # When adding a directory, only the folder that's added (and everything below) should appear in the metadata
+  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?(File.basename(File.dirname(VALIDPATH))) }
+  end
+
+  def test_default_privacy
+     @torrent.add_file(VALIDFILEPATH)
+     assert_equal 0, @torrent.privacy
+  end
+
+  def test_set_privacy
+     test_default_privacy
+     @torrent.set_private
+     assert_equal 1, @torrent.privacy
+  end
+
+  def test_set_valid_webseed
+    @torrent.set_webseed(WEBSEED)
+    assert_equal WEBSEED, @torrent.webseed
+  end
+
+  def test_add_invalid_webseed
+    assert_raises(ArgumentError) {
+      @torrent.set_webseed('uheoatnhuetano')
+    }
+  end
+
+  def test_torrent2_equality
+     assert_equal @torrent, @torrent2
+     @torrent2.tracker = 'http://example.com'
+     assert @torrent == @torrent2, 'info hash should still match, so torrent == torrent2'
+     assert !@torrent.eql?(@torrent2), 'announce uri changed, so torrent ! eql? torrent2'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/reporters'
+require 'shellwords'
+
+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"
+SNDTRACKER = "udp://test.tracker.tk:80"
+THDTRACKER = "udp://open.testtracker.com:6500/announce"
+WEBSEED = "http://seed.example.com/webseed"
+EXPECTED_INFOHASH = "a8036d51ada8fb699c9f29d7861e5589f2d20cf9"
+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

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: ll-mktorrent
+version: !ruby/object:Gem::Version
+  version: 1.8.0
+platform: ruby
+authors:
+- Timothy Mukaibo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bencode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: Create .torrent files easily with this gem. The code is ugly, but it
+  works :)
+email: timothy@mukaibo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mktorrent.rb
+- test/mktorrent_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mukaibot/mktorrent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Create .torrent files easily with this gem
+test_files:
+- test/mktorrent_test.rb
+- test/test_helper.rb