ruby_bittorrent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d414bccb8ae337061e4e52c33fc3c290fe27e263
+  data.tar.gz: c06b01fc80b167b15822e1e7e89b2be7e5590262
+SHA512:
+  metadata.gz: 3274ee4c62a91d6fd070113a9e4a1e0c33a00b5c73eb8efb84d82a359514bff77a7e02c26980e1c9923dcbc1a9ec95f23e32bf9f7027ef9561160870c4872dec
+  data.tar.gz: 83ad6ca6329c9df9a9768b4341e47ffae1991a17539f440e4ad7e7088851ca783285e1b164c947319c13e6e2faebae02656ff12f3432b8874860298e8b4597f2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+ruby_bittorrent

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem 'simplecov', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Marcin Nowicki
+
+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/README.rdoc

@@ -0,0 +1,23 @@
+= ruby_bittorrent
+
+Ruby bittorrent download cli.
+
+= requirements
+Installed aria2 package in system (with bittorrent support).
+
+
+== Contributing to ruby_bittorrent
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Marcin Nowicki. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ruby_bittorrent"
+  gem.homepage = "http://github.com/pr0d1r2/ruby_bittorrent"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby bittorrent download cli.}
+  gem.description = %Q{Ruby bittorrent download cli.}
+  gem.email = "pr0d1r2@gmail.com"
+  gem.authors = ["Marcin Nowicki"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby_bittorrent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/bit_torrent.rb

@@ -0,0 +1,61 @@
+class BitTorrent
+
+  class DownloadError < StandardError
+  end
+
+  DEFAULTS = {
+    :upload_rate_limit => 0,
+    :seed_ratio => 1.5,
+    :connect_timeout => 60,
+    :timeout => 60,
+    :stop_timeout => 0,
+    :destination_directory => "."
+  }
+
+  attr :sources
+  attr *DEFAULTS.keys
+
+  def initialize(source, options = {})
+    @sources = [ source ].flatten
+    DEFAULTS.keys.each do |option|
+      self.instance_variable_set("@#{option}", (options[option] || DEFAULTS[option]))
+    end
+  end
+
+  def self.download(sources, options = {})
+    new(sources, options).download
+  end
+
+  def self.download!(sources, options = {})
+    new(sources, options).download!
+  end
+
+  def download
+    system(download_commmand)
+  end
+
+  def download!
+    download or raise DownloadError
+  end
+
+  private
+
+    def download_commmand
+      [
+        'aria2c',
+        "--dir=#{destination_directory}",
+        '--bt-enable-lpd',
+        '--bt-min-crypto-level=arc4',
+        '--bt-require-crypto=true',
+        '--enable-dht=true',
+        '--enable-peer-exchange=true',
+        "--max-overall-upload-limit=#{upload_rate_limit}",
+        "--seed-ratio=#{seed_ratio}",
+        "--bt-tracker-connect-timeout=#{connect_timeout}",
+        "--bt-tracker-timeout=#{timeout}",
+        "--bt-stop-timeout=#{stop_timeout}",
+        sources.map { |s| "'#{s}'" }
+      ].flatten.join(' ')
+    end
+
+end

data/lib/ruby_bittorrent.rb

@@ -0,0 +1 @@
+require_relative 'bit_torrent'

data/ruby_bittorrent.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "ruby_bittorrent"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marcin Nowicki"]
+  s.date = "2013-08-16"
+  s.description = "Ruby bittorrent download cli."
+  s.email = "pr0d1r2@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-gemset",
+    ".ruby-version",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/bit_torrent.rb",
+    "lib/ruby_bittorrent.rb",
+    "ruby_bittorrent.gemspec",
+    "spec/bit_torrent_spec.rb",
+    "spec/spec_helper.rb",
+    "test/helper.rb",
+    "test/test_ruby_bittorrent.rb"
+  ]
+  s.homepage = "http://github.com/pr0d1r2/ruby_bittorrent"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "Ruby bittorrent download cli."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/bit_torrent_spec.rb

@@ -0,0 +1,141 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe BitTorrent do
+
+  let(:source) { "magnet:?xt=urn:btih:source" }
+  let(:sources) { source }
+  let(:options) { {} }
+  let(:the_class) { BitTorrent }
+  let(:the_object) { the_class.new(sources, options) }
+
+  describe "object" do
+    subject { the_object }
+
+    its(:upload_rate_limit) { should == 0 }
+    its(:seed_ratio) { 1.5 }
+    its(:connect_timeout) { 60 }
+    its(:timeout) { 60 }
+    its(:stop_timeout) { 0 }
+    its(:destination_directory) { "." }
+
+    its(:download_commmand) { should == "aria2c --dir=. --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=0 --seed-ratio=1.5 --bt-tracker-connect-timeout=60 --bt-tracker-timeout=60 --bt-stop-timeout=0 '#{source}'" }
+
+    context "when change upload rate limit" do
+      let(:options) { {:upload_rate_limit => "5K" } }
+
+      its(:upload_rate_limit) { should == "5K" }
+
+      its(:download_commmand) { should == "aria2c --dir=. --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=5K --seed-ratio=1.5 --bt-tracker-connect-timeout=60 --bt-tracker-timeout=60 --bt-stop-timeout=0 '#{source}'" }
+    end
+
+    context "when change seed ratio" do
+      let(:options) { {:seed_ratio => 1 } }
+
+      its(:seed_ratio) { should == 1 }
+
+      its(:download_commmand) { should == "aria2c --dir=. --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=0 --seed-ratio=1 --bt-tracker-connect-timeout=60 --bt-tracker-timeout=60 --bt-stop-timeout=0 '#{source}'" }
+    end
+
+    context "when change connect timeout" do
+      let(:options) { {:connect_timeout => 120 } }
+
+      its(:connect_timeout) { should == 120 }
+
+      its(:download_commmand) { should == "aria2c --dir=. --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=0 --seed-ratio=1.5 --bt-tracker-connect-timeout=120 --bt-tracker-timeout=60 --bt-stop-timeout=0 '#{source}'" }
+    end
+
+    context "when change timeout" do
+      let(:options) { {:timeout => 120 } }
+
+      its(:timeout) { should == 120 }
+
+      its(:download_commmand) { should == "aria2c --dir=. --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=0 --seed-ratio=1.5 --bt-tracker-connect-timeout=60 --bt-tracker-timeout=120 --bt-stop-timeout=0 '#{source}'" }
+    end
+
+    context "when change stop timeout" do
+      let(:options) { {:stop_timeout => 120 } }
+
+      its(:stop_timeout) { should == 120 }
+
+      its(:download_commmand) { should == "aria2c --dir=. --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=0 --seed-ratio=1.5 --bt-tracker-connect-timeout=60 --bt-tracker-timeout=60 --bt-stop-timeout=120 '#{source}'" }
+    end
+
+    context "when change destination directory" do
+      let(:options) { {:destination_directory => "/tmp" } }
+
+      its(:destination_directory) { should == "/tmp" }
+
+      its(:download_commmand) { should == "aria2c --dir=/tmp --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=0 --seed-ratio=1.5 --bt-tracker-connect-timeout=60 --bt-tracker-timeout=60 --bt-stop-timeout=0 '#{source}'" }
+    end
+
+    context "when have 2 sources" do
+      let(:source2) { "magnet:?xt=urn:btih:source2" }
+      let(:sources) { [source, source2] }
+
+      it "TODO"
+    end
+  end
+
+  describe ".download" do
+    before do
+      the_object.stub(:download => true)
+      the_class.stub(:new => the_object)
+    end
+    after { the_class.download(source, options) }
+
+    it "should create new instance" do
+      the_class.should_receive(:new).with(source, options)
+    end
+
+    it "should call #download on new instance" do
+      the_object.should_receive(:download)
+    end
+  end
+
+  describe ".download!" do
+    before do
+      the_object.stub(:download! => true)
+      the_class.stub(:new => the_object)
+    end
+
+    after { the_class.download!(source, options) }
+
+    it "should create new instance" do
+      the_class.should_receive(:new).with(source, options)
+    end
+
+    it "should call #download on new instance" do
+      the_object.should_receive(:download!)
+    end
+  end
+
+  describe "#download" do
+    after { the_object.download }
+
+    it "should run download command in system" do
+      the_object.should_receive(:system).with("aria2c --dir=. --bt-enable-lpd --bt-min-crypto-level=arc4 --bt-require-crypto=true --enable-dht=true --enable-peer-exchange=true --max-overall-upload-limit=0 --seed-ratio=1.5 --bt-tracker-connect-timeout=60 --bt-tracker-timeout=60 --bt-stop-timeout=0 '#{source}'")
+    end
+  end
+
+  describe "#download!" do
+    let(:download_status) { true }
+    before { the_object.stub(:download => download_status) }
+
+    it "should run download" do
+      the_object.should_receive(:download).and_return(true)
+      the_object.download!
+    end
+
+    context "when download failed" do
+      let(:download_status) { false }
+
+      it {
+        expect {
+          the_object.download!
+        }.to raise_error(BitTorrent::DownloadError)
+      }
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'simplecov'
+SimpleCov.start
+SimpleCov.minimum_coverage 100
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'ruby_bittorrent'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ruby_bittorrent'
+
+class Test::Unit::TestCase
+end

data/test/test_ruby_bittorrent.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRubyBittorrent < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: ruby_bittorrent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marcin Nowicki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: Ruby bittorrent download cli.
+email: pr0d1r2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/bit_torrent.rb
+- lib/ruby_bittorrent.rb
+- ruby_bittorrent.gemspec
+- spec/bit_torrent_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_ruby_bittorrent.rb
+homepage: http://github.com/pr0d1r2/ruby_bittorrent
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby bittorrent download cli.
+test_files: []