sinatra-torrent 0.0.5 → 0.0.6

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake'
+require 'rspec/core/rake_task'
 
 begin
   require 'jeweler'
@@ -11,32 +12,22 @@ begin
     gem.authors = ["JP Hastings-Spital"]
     
     gem.add_dependency('sinatra','>=1.1.2') # Required for send_file modifications
+    gem.add_dependency('bencode')
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+task :default => :test
+task :test => :spec
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+if !defined?(RSpec)
+  puts "spec targets require RSpec"
+else
+  desc "Run all examples"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+    t.rspec_opts = ['-cfs']
   end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
+end

data/Readme.md

@@ -13,20 +13,24 @@ Usage
 
 "Woah, that's pretty simple!" I hear you say. Why yes, I think it is.
 
-All files you put in the `downloads` directory at the root of your sinatra app will be downloadable at `/downloads/your_file.ext` and it's torrent will be dynamically generated (and cached) at `/torrents/your_file.ext.torrent`. You will have trouble with larger files as it currently hashes as part of the request first time round. I'm planning on pushing this out to workers at some point. Not yet sure how I'm going to do that…
+All files you put in the `downloads` directory at the root of your sinatra app will be downloadable at `/downloads/your_file.ext` and it's torrent will be dynamically generated (and cached) at `/torrents/your_file.ext.torrent`. If a torrent file takes over 1 second to be generated, it'll be put in a queue for creation in a background job. You can run these background jobs using the Rake helper (see below).
+
+If you have set the `:torrent_timeout` sinatra setting to a `Proc`, it will be run (synchronously!) after the delayed job has been queued and before the user is sent the error message. eg. `set :torrent_timeout, Proc.new { start_process_forked_running_rake_hash_queue }`
 
 ### I want options!
 
-There needs to be a database of torrents and peers, this is taken care of by a database adapter. Currently I've written (a really basic) one for active record, so many databases are supported as is, but you can write your own for others (eg. mongo). I'm still finding my way around the Sinatra extensions api, so this is how you specify your own ActiveRecord settings:
+There needs to be a database of torrents, peers and background hashing jobs, this is taken care of by a database adapter. Currently I've written (a really basic) one for active record, so many databases are supported as is, but you can write your own for others (eg. mongo). I'm still finding my way around the Sinatra extensions api, so this is how you specify your own ActiveRecord settings:
 
     require 'sinatra'
     require 'sinatra/torrent/activerecord'
-    SinatraTorrentDatabase.settings = {
+    Sinatra::Torrent::Database.settings = {
 	  'adapater' => 'sqlite3',
 	  'database' => 'torrents.db'
     }
     require 'sinatra/torrent'
 
+The active record adapter is loaded by default if no others are specified and an SQLite database will be maintained in memory unless settings (like those above) are specified. This means that, unless you set options like this, when your app shuts down your hashes will be lost!
+
 Rake
 ----
 
@@ -55,7 +59,7 @@ If a torrent takes longer than 1 second to generate on-the-fly, it'll be added t
 To Do
 -----
 
-* Execute a user-writen block of code when an on-the-fly torrent creation times out. This will allow people to trigger the background rake task immediately, rather than waiting on cron.
+* Get the BitTornado webseed style to work.
 
 Ummmm
 -----

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/sinatra/torrent.rb

@@ -8,17 +8,25 @@ require 'sinatra/torrent/helpers'
 
 module Sinatra
   module Torrent
-    
-    # Options etc
+    # Sets the settings for the app
+    def self.settings=(settings = {})
+      @@settings = {
+        # Directory which holds all the files which will be provided as torrents
+        :downloads_directory => File.join(File.dirname(__FILE__),Sinatra::Torrent.downloads_directory),
+        # Mount point for the downloads directory
+        :downloads_mount => 'downloads',
+        # Mount point for the torrents directory
+        :torrents_mount => 'torrents'
+      }
+      settings.each { |key,value| @@settings[key] = value unless @@settings[value].nil? }
+    end
+
+    # settings etc
     def self.registered(app)
+      # Set default settings
+      begin @@settings rescue self.settings=({}) end
       # Putting the annouce URL of a tracker in here will use that tracker rather than the inbuilt one
       app.set :external_tracker, nil
-      # Directory which holds all the files which will be provided as torrents
-      app.set :downloads_directory, File.join(File.dirname(__FILE__),Sinatra::Torrent.downloads_directory)
-      # Mount point for the downloads directory
-      app.set :downloads_mount, 'downloads'
-      # Mount point for the torrents directory
-      app.set :torrents_mount, 'torrents'
       # Load up a database adapter if one isn't already loaded
       require 'sinatra/torrent/activerecord' unless (Sinatra::Torrent.const_defined?('Database') rescue false)
       # Stores the instance of the database used to store tracker info.
@@ -28,25 +36,26 @@ module Sinatra
       # Do we wish to track external torrents too? (untested)
       app.set :allow_external_torrents, false
       # The frequency with which we ask trackers to announce themselves. Once every x seconds
-      app.set :announce_frequency, 30
+      app.set :announce_frequency, 900
+      # Method to call when torrent creation timesout
+      app.set :torrent_timeout, nil
       
 # TORRENTS
 
       app.mime_type :torrent, 'application/x-bittorrent'
 
       # Serves up the torrents with appropriate announce URL
-      app.get Regexp.new("^/#{app.options.torrents_mount}/(.+)\.torrent$") do |rel_location|
-        filename = File.join(options.downloads_directory, rel_location)
+      app.get Regexp.new("^/#{@@settings[:torrents_mount]}/(.+)\.torrent$") do |rel_location|
+        filename = File.join(@@settings[:downloads_directory], rel_location)
         halt(404, "That file doesn't exist! #{filename}") unless File.exists?(filename)
         
-        if !(d = options.database_adapter.torrent_by_path_and_timestamp(rel_location,File.mtime(filename)))
-          p d
+        if !(d = settings.database_adapter.torrent_by_path_and_timestamp(rel_location,File.mtime(filename)))
           begin
             Timeout::timeout(1) do
               d = Sinatra::Torrent.create(filename)
             end
           rescue Timeout::Error
-            eta = options.database_adapter.add_hashjob(rel_location)
+            eta = settings.database_adapter.add_hashjob(rel_location)
             
             begin
               wait = case (eta/60).floor
@@ -61,18 +70,21 @@ module Sinatra
               wait = "a short while"
             end
             
+            settings.torrent_timeout.call if settings.torrent_timeout.is_a?(Proc)
+            
             halt(503,"This torrent is taking too long to build, we're running it in the background. Please try again in #{wait}.")
           end
           
-          options.database_adapter.store_torrent(rel_location,File.mtime(filename),d['metadata'],d['infohash'])
+          settings.database_adapter.store_torrent(rel_location,File.mtime(filename),d['metadata'],d['infohash'])
         end
         
-        # These are options which could change between database retrievals
+        # These are settings which could change between database retrievals
         d['metadata'].merge!({
-          'httpseeds' => [File.join('http://'+env['HTTP_HOST'],URI.encode(options.torrents_mount),'webseed')],
-          'url-list' => [File.join('http://'+env['HTTP_HOST'],URI.encode(options.downloads_mount),URI.encode(rel_location)+'?'+d['infohash'])],
-          'announce' => options.external_tracker || File.join('http://'+env['HTTP_HOST'],URI.encode(options.torrents_mount),'announce'),
-          'comment' => options.torrent_comment,
+# Webseeds not currently supported
+#          'httpseeds' => [File.join('http://'+env['HTTP_HOST'],URI.encode(settings.torrents_mount),'webseed')],
+          'url-list' => [File.join('http://'+env['HTTP_HOST'],URI.encode(@@settings[:downloads_mount]),URI.encode(rel_location)+'?'+d['infohash'])],
+          'announce' => settings.external_tracker || File.join('http://'+env['HTTP_HOST'],URI.encode(@@settings[:torrents_mount]),'announce'),
+          'comment' => settings.torrent_comment,
         })
         
         content_type :torrent, :charset => 'utf-8'
@@ -82,13 +94,13 @@ module Sinatra
 # TRACKER
       
       # Tracker announce mount point
-      app.get "/#{app.options.torrents_mount}/announce" do
+      app.get "/#{@@settings[:torrents_mount]}/announce" do
         # Convert to a hex info_hash if required TODO: Is it required?
         params['info_hash'] = Digest.hexencode(params['info_hash'] || '')
         halt(400,"A valid info-hash was not given") if params['info_hash'].match(/^[0-9a-f]{40}$/).nil?
-        info = options.database_adapter.torrent_info(params['info_hash'])
+        info = settings.database_adapter.torrent_info(params['info_hash'])
         
-        if (!options.allow_external_torrents and !options.database_adapter.torrent_by_infohash(params['info_hash']))
+        if (!settings.allow_external_torrents and !settings.database_adapter.torrent_by_infohash(params['info_hash']))
           return {
             'failure reason' => 'This tracker does not track that torrent'
           }.bencode
@@ -102,54 +114,68 @@ module Sinatra
         params['peer_id'] = params['peer_id'].force_encoding("ISO-8859-1")
         
         # Registers this peer's announcement
-        options.database_adapter.announce(params)
+        settings.database_adapter.announce(params)
 
         {
-          'interval' => options.announce_frequency,
+          'interval' => settings.announce_frequency,
           #'tracker id' => 'bleugh', # TODO: Keep this?
           'complete' => info['complete'],
           'incomplete' => info['incomplete'],
-          'peers' => options.database_adapter.peers_by_infohash(params['info_hash'],[params['peer_id']],(params['numwant'] || 50).to_i),
+          'peers' => settings.database_adapter.peers_by_infohash(params['info_hash'],[params['peer_id']],(params['numwant'] || 50).to_i),
         }.bencode
       end
       
       # TODO: Scrape
       app.get '/torrents/scrape' do
-        # TODO: Make it work!
+        {
+          'files' => Hash[*request.env['QUERY_STRING'].scan(/info_hash=([0-9a-f]{20})/).collect do |infohash|
+            torrent = settings.database_adapter.torrent_by_infohash(infohash[0])
+            next if !torrent
+            stats = settings.database_adapter.torrent_info(infohash[0])
+            [
+              torrent['infohash'],
+              {
+                'complete'   => stats['complete'],
+                'downloaded' => 0,
+                'incomplete' => stats['incomplete'],
+                'name'       => File.basename(torrent['path'])
+              }
+            ]
+          end.compact.flatten]
+        }.bencode
       end
 
 # INDEX PAGE
 
-      # TODO: Have a 'fallback' index view?
-      app.get "/#{app.options.torrents_mount}/" do
-        locals = {:torrents => (Dir.glob("#{options.downloads_directory}/**").collect {|f| f[options.downloads_directory.length+1..-1] } rescue [])}
+      app.get "/#{@@settings[:torrents_mount]}/" do
+        locals = {:torrents => (Dir.glob("#{@@settings[:downloads_directory]}/**").collect {|f| {:file => f[@@settings[:downloads_directory].length+1..-1],:hashed? => settings.database_adapter.torrent_by_path_and_timestamp(f[@@settings[:downloads_directory].length+1..-1],File.mtime(f)) != false} } rescue [])}
         begin
           haml :torrents_index,:locals => locals
         rescue Errno::ENOENT
-          "<ul>"<<locals[:torrents].collect{|t| "<li><a href=\"/#{options.torrents_mount}/#{t}.torrent\">#{t}</a></li>" }.join<<"</ul>"
+          "<ul>"<<locals[:torrents].collect{|t| "<li><a href=\"/#{@@settings[:torrents_mount]}/#{t[:file]}.torrent\" class=\"#{(t[:hashed?] ? 'ready' : 'unhashed')}\">#{t[:file]}</a></li>" }.join<<"</ul>"
         end
       end
 
 # DATA
 
+=begin : Not currently supported
       # BitTornado WebSeeding manager
-      app.get "/#{app.options.torrents_mount}/webseed" do
+      # http://bittornado.com/docs/webseed-spec.txt
+      app.get "/#{settings.torrents_mount}/webseed" do
         # Which file is the client looking for?
-        halt(404, "Torrent not tracked") unless (options.database_adapter.torrent_by_infohash(params[:infohash]))
+        halt(404, "Torrent not tracked") unless (d = settings.database_adapter.torrent_by_infohash(params[:infohash]))
         
-        # http://bittornado.com/docs/webseed-spec.txt
         
-        # TODO: intelligent wait period
-        halt(503,"15") if false # ask clients to wait 15 seconds before requesting again
       end
+=end
       
       # Provides the files for web download. Any query parameters are treated as a checksum for the file (via the torrent infohash)
-      app.get "/#{app.options.downloads_mount}/:filename" do
-        filename = File.join(options.downloads_directory,File.expand_path('/'+params[:filename]))
+      app.get "/#{@@settings[:downloads_mount]}/:filename" do
+        filename = File.join(@@settings[:downloads_directory],File.expand_path('/'+params[:filename]))
         halt(404) unless File.exists?(filename)
         
         # If there are query params then we assume it's specifying a specific version of the file by info_hash
-        halt(409,"The file is no longer the same as the one specified in your torrent") if !env['QUERY_STRING'].empty? and (options.database_adapter.torrent_by_path_and_timestamp(filename,File.mtime(filename))['infohash'] rescue nil) != env['QUERY_STRING'] 
+        halt(409,"The file is no longer the same as the one specified in your torrent") if !env['QUERY_STRING'].empty? and (settings.database_adapter.torrent_by_path_and_timestamp(filename,File.mtime(filename))['infohash'] rescue nil) != env['QUERY_STRING'] 
         send_file(filename)
       end
     end

data/lib/sinatra/torrent/activerecord.rb

@@ -1,6 +1,8 @@
 # The active record adapter works with SQLite3 in memory by default
 require 'active_record'
 
+ActiveRecord::Base.logger = nil
+
 module Sinatra
   module Torrent
     # This is the wrapper class used by sinatra-torrent to communicate with
@@ -21,7 +23,7 @@ module Sinatra
       # Makes sure the table is present & ready, log in using the settings
       def initialize
         @db = ActiveRecord::Base.establish_connection(@@settings)
-    
+
         unless Torrent.table_exists?
           ActiveRecord::Schema.define do
             create_table :torrents do |table|

data/sinatra-torrent.gemspec

@@ -1,44 +1,47 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{sinatra-torrent}
-  s.version = "0.0.5"
+  s.name = "sinatra-torrent"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["JP Hastings-Spital"]
-  s.date = %q{2011-02-10}
-  s.description = %q{An extension to Sinatra which will allow you to run a webseeded torrent tracker of files in the folder you specify.}
-  s.email = %q{jphastings@gmail.com}
+  s.date = "2012-07-01"
+  s.description = "An extension to Sinatra which will allow you to run a webseeded torrent tracker of files in the folder you specify."
+  s.email = "jphastings@gmail.com"
   s.files = [
     "Rakefile",
-     "Readme.md",
-     "VERSION",
-     "lib/sinatra/torrent.rb",
-     "lib/sinatra/torrent/activerecord.rb",
-     "lib/sinatra/torrent/hashing.rb",
-     "lib/sinatra/torrent/helpers.rb",
-     "sinatra-torrent.gemspec"
+    "Readme.md",
+    "VERSION",
+    "lib/sinatra/torrent.rb",
+    "lib/sinatra/torrent/activerecord.rb",
+    "lib/sinatra/torrent/hashing.rb",
+    "lib/sinatra/torrent/helpers.rb",
+    "sinatra-torrent.gemspec",
+    "spec/spec_helper.rb",
+    "spec/torrent_spec.rb"
   ]
-  s.homepage = %q{http://github.com/jphastings/sinatra-torrent}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.homepage = "http://github.com/jphastings/sinatra-torrent"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A sinatra extension to run webseeded torrent tracker}
+  s.rubygems_version = "1.8.24"
+  s.summary = "A sinatra extension to run webseeded torrent tracker"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, [">= 1.1.2"])
+      s.add_runtime_dependency(%q<bencode>, [">= 0"])
     else
       s.add_dependency(%q<sinatra>, [">= 1.1.2"])
+      s.add_dependency(%q<bencode>, [">= 0"])
     end
   else
     s.add_dependency(%q<sinatra>, [">= 1.1.2"])
+    s.add_dependency(%q<bencode>, [">= 0"])
   end
 end
 

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'sinatra'
+require 'rack/test'
+
+module RSpecMixin
+  include Rack::Test::Methods
+  def app() Sinatra::Application end
+end
+
+RSpec.configure { |c| c.include RSpecMixin }

data/spec/torrent_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+require File.join(File.dirname(__FILE__),'..','lib','sinatra','torrent')
+
+describe 'The Torrent extension' do
+	it 'should load correctly in sinatra'
+
+	describe 'the scrape url' do
+		it 'should provide scrape information' do
+
+		end
+
+		it 'should provide scrape information for multiple infohashes' do
+			
+		end
+	end
+
+	it 'should have more test cases'
+end

metadata

@@ -1,48 +1,55 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sinatra-torrent
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-10 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 1
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: bencode
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: An extension to Sinatra which will allow you to run a webseeded torrent tracker of files in the folder you specify.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An extension to Sinatra which will allow you to run a webseeded torrent
+  tracker of files in the folder you specify.
 email: jphastings@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Rakefile
 - Readme.md
 - VERSION
@@ -51,39 +58,30 @@ files:
 - lib/sinatra/torrent/hashing.rb
 - lib/sinatra/torrent/helpers.rb
 - sinatra-torrent.gemspec
-has_rdoc: true
+- spec/spec_helper.rb
+- spec/torrent_spec.rb
 homepage: http://github.com/jphastings/sinatra-torrent
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A sinatra extension to run webseeded torrent tracker
 test_files: []
-