torckapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29d24fdd398ac1eb525d2f7e549b28758503aaf8
+  data.tar.gz: 2166897e0f941f25da66e84c1c8a2fc8dd6ac9e0
+SHA512:
+  metadata.gz: bc75dd6ed40fe0d9ee30cad1edb8552fb143d089856e86f26a6266ac0d91de5a5b9dd08e81f28121329bd23d8e1362b7079acfad8f2bc91f17d5d38feac46487
+  data.tar.gz: 0fb9ac7f55e5aafb757d566c57b452b74c90c49c645c3ec20904f43c9d7990cef164248a27b8e5f24d91004bade06dd7275c745fbfbfbba3f196ec7f85611fae

data/.gitignore

@@ -0,0 +1,3 @@
+.yardoc
+doc
+

data/Gemfile

@@ -0,0 +1 @@
+source 'https://rubygems.org'

data/Gemfile.lock

@@ -0,0 +1,8 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES

data/README.md

@@ -0,0 +1,37 @@
+# Torckapi — torrent tracker querying API
+
+## Description
+
+Torckapi is a querying interface to torrent trackers.
+
+## Synopsis
+
+```
+tracker = Torckapi.tracker("udp://generic.url:80/announce")
+# => #<Torckapi::Tracker::UDP:0x007fb5941f6ef8
+#      @url=#<URI::Generic:0x007fb5941f7038 URL:udp://generic.url:80/announce>,
+#      @options={:timeout=>15, :tries=>3}>
+```
+
+### Queries
+```
+tracker.announce("0123456789ABCDEF0123456789ABCDEF01234567")
+# => #<Torckapi::Response::Announce:0x007fa1bc0f11c0
+#      @info_hash="0123456789ABCDEF0123456789ABCDEF01234567",
+#      @leechers=1,
+#      @seeders=1,
+#      @peers=[["127.0.0.1", 54078], ["127.0.0.2", 43666]]>
+
+tracker.scrape(["0123456789ABCDEF0123456789ABCDEF01234567", "123456789ABCDEF0123456789ABCDEF012345678"])
+# => #<Torckapi::Response::Scrape:0x007fa1bc0fe320
+#      @data={"0123456789ABCDEF0123456789ABCDEF01234567"=>{:seeders=>3, :completed=>0, :leechers=>13},
+#             "123456789ABCDEF0123456789ABCDEF012345678"=>{:seeders=>4, :completed=>10, :leechers=>8}}>
+```
+
+## TODO
+
+Add tests.
+
+Add HTTP implementation.
+
+Document everything.

data/lib/torckapi/errors.rb

@@ -0,0 +1,10 @@
+module Torckapi
+  class Error < StandardError; end
+  class InvalidInfohashError < Error; end
+
+  module Tracker
+    class Error < Torckapi::Error; end
+    class InvalidSchemeError < Error; end
+    class CommunicationTimeoutError < Error; end
+  end
+end

data/lib/torckapi/response/announce.rb

@@ -0,0 +1,37 @@
+require 'ipaddr'
+
+module Torckapi
+  module Response
+    class Announce
+      # @!attribute [r] info_hash
+      #   @return [String] 40-char hexadecimal string
+      # @!attribute [r] leechers
+      #   @return [Fixnum] number of leechers
+      # @!attribute [r] peers
+      #   @return [Array<IPAddr, Fixnum>] list of peers
+      # @!attribute [r] seeders
+      #   @return [Fixnum] number of seeders
+      attr_reader :info_hash, :leechers, :peers, :seeders
+
+      # Construct response object from udp response data
+      # @param info_hash [String] 40-char hexadecimal string
+      # @param data [String] UDP response data (omit action and transaction_id)
+      # @return [Torckapi::Response::Announce] response
+      def self.from_udp info_hash, data
+        leechers, seeders = data[0..7].unpack('L>2')
+        peers = data[8..-1].unpack('a6' * (leechers + seeders)).map { |i| [IPAddr.ntop(i[0..3]), i[4..5].unpack('S>')[0]] }
+      
+        new info_hash, leechers, seeders, peers
+      end
+      
+      private
+      
+      def initialize info_hash, leechers, seeders, peers
+        @info_hash = info_hash
+        @leechers = leechers
+        @seeders = seeders
+        @peers = peers
+      end
+    end
+  end
+end

data/lib/torckapi/response/scrape.rb

@@ -0,0 +1,24 @@
+module Torckapi
+  module Response
+    
+    # Scrape response
+    class Scrape
+      # @return [Hash<String, Hash>] scrape data
+      attr_reader :data
+    
+      # Construct response object from udp response data
+      # @param info_hashes [Array<String>] list of 40-char hexadecimal strings
+      # @param data [String] UDP response data (omit action and transaction_id)
+      # @return [Torckapi::Response::Scrape] response
+      def self.from_udp info_hashes, data
+        new Hash[info_hashes.zip(data.unpack('a12' * (info_hashes.count)).map { |i| Hash[[:seeders, :completed, :leechers].zip i.unpack('L>3').map(&:to_i)] })]
+      end
+      
+      private
+    
+      def initialize data
+        @data = data
+      end
+    end
+  end
+end

data/lib/torckapi/tracker/base.rb

@@ -0,0 +1,28 @@
+module Torckapi
+  module Tracker
+    
+    # Public interface for torrent trackers
+    class Base
+      # Announce Request
+      # @param info_hash [String] 40-char hexadecimal string
+      # @return [Torckapi::AnnounceResponse] a response object
+      def announce info_hash
+        raise Torckapi::InvalidInfohashError if info_hash !~ /\A[0-9a-f]{40}\z/i
+      end
+
+      # Scrape Request
+      # @param info_hashes [String, Array<String>] A single 40-char hexadecimal string or an array of those
+      # @return [Torckapi::ScrapeResponse] a response object
+      def scrape info_hashes=[]
+        raise Torckapi::InvalidInfohashError if [*info_hashes].any? { |i| i !~ /\A[0-9a-f]{40}\z/i }
+      end
+      
+      private
+      
+      def initialize url, options={}
+        @url = url
+        @options = {timeout: 15, tries: 3}.merge(options)
+      end
+    end
+  end
+end

data/lib/torckapi/tracker/http.rb

@@ -0,0 +1,10 @@
+require_relative 'base'
+
+module Torckapi
+  module Tracker
+    
+    # @todo implement
+    class HTTP < Base
+    end
+  end
+end

data/lib/torckapi/tracker/udp.rb

@@ -0,0 +1,77 @@
+require 'socket'
+require 'timeout'
+require 'securerandom'
+require_relative 'base'
+
+module Torckapi
+  module Tracker
+    
+    # Implementation of http://www.bittorrent.org/beps/bep_0015.html
+    class UDP < Base
+      # connection_id is valid for 1 minute as per protocol
+      CONNECTION_TIMEOUT = 60
+      
+      # @see Base#announce
+      def announce info_hash
+        super info_hash
+        
+        data = [[info_hash].pack('H*'), SecureRandom.random_bytes(20), [0, 0, 0, 0, 0, 0, -1, 0].pack('Q>3L>4s>')].join
+
+        connect
+        response_body = communicate(1, data)[0] # announce
+
+        Torckapi::Response::Announce.from_udp info_hash, response_body[12..-1]
+      end
+      
+      def scrape info_hashes=[]
+        super info_hashes
+
+        data = [*info_hashes].map { |i| [i].pack('H*') }.join
+        
+        connect
+        response_body = communicate(2, data)[0] # scrape
+        
+        Torckapi::Response::Scrape.from_udp [*info_hashes], response_body[8..-1]
+      end
+
+      private
+
+      def initialize *args
+        super *args
+      end
+      
+      def connect
+        return if @connection_id && @communicated_at.to_i >= Time.now.to_i - CONNECTION_TIMEOUT
+        
+        @connection_id = [0x41727101980].pack('Q>')
+        response_body = communicate(0)[0] # connect
+        @connection_id = response_body[8..15]
+        puts "connection_id = #{@connection_id.inspect}" if Torckapi::debug
+      end
+      
+      def communicate action, data=nil
+        @socket ||= UDPSocket.new
+        
+        transaction_id = SecureRandom.random_bytes(4)
+        packet = [@connection_id, [action].pack('L>'), transaction_id, data].join
+
+        tries = 0
+        response = nil
+        begin
+          Timeout::timeout(@options[:timeout], CommunicationTimeoutError) do
+            puts "--> #{packet.inspect}" if Torckapi::debug
+            @socket.send(packet, 0, @url.host, @url.port)
+            response = @socket.recvfrom(65536)
+            puts "<-- #{response.inspect}" if Torckapi::debug
+            raise TransactionIdMismatchError if transaction_id != response[0][4..7]
+            @communicated_at = Time.now
+          end
+        rescue CommunicationTimeoutError
+          retry if (tries += 1) <= @options[:tries] 
+        end
+        
+        response
+      end
+    end
+  end
+end

data/lib/torckapi/version.rb

@@ -0,0 +1,3 @@
+module Torckapi
+  VERSION = "0.0.1"
+end

data/lib/torckapi.rb

@@ -0,0 +1,36 @@
+require 'uri'
+require 'torckapi/version'
+require 'torckapi/errors'
+require 'torckapi/tracker/http'
+require 'torckapi/tracker/udp'
+require 'torckapi/response/announce'
+require 'torckapi/response/scrape'
+
+module Torckapi
+  @@debug = false
+  
+  def self.debug
+    @@debug
+  end
+  
+  def self.debug= debug
+    @@debug = !!debug
+  end
+  
+  # Creates a tracker interface instance
+  # @param tracker_url [String] tracker announce url
+  # @param options [Hash] defaults to \\{timeout: 15, tries: 3}
+  # @return [Torckapi::Tracker::Base] tracker interface instance
+  def self.tracker tracker_url, options={}
+    url = URI.parse tracker_url
+
+    case url.scheme
+    when "http"
+      Torckapi::Tracker::HTTP.new url, options
+    when "udp"
+      Torckapi::Tracker::UDP.new url, options
+    else
+      raise InvalidSchemeError, "'#{tracker_url}' cannot be recognized as valid tracker url"
+    end
+  end
+end

data/torckapi.gemspec

@@ -0,0 +1,20 @@
+$:.unshift "lib"
+require 'torckapi/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dennis Krupenik"]
+  gem.email         = ["dennis@krupenik.com"]
+  gem.description   = %q{torrent tracker api}
+  gem.summary       = %q{torckapi is a tool for quering torrent trackers}
+  gem.homepage      = "https://github.com/krupenik/torckapi"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "torckapi"
+  gem.require_paths = ["lib"]
+  gem.version       = Torckapi::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: torckapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Krupenik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  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: torrent tracker api
+email:
+- dennis@krupenik.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/torckapi.rb
+- lib/torckapi/errors.rb
+- lib/torckapi/response/announce.rb
+- lib/torckapi/response/scrape.rb
+- lib/torckapi/tracker/base.rb
+- lib/torckapi/tracker/http.rb
+- lib/torckapi/tracker/udp.rb
+- lib/torckapi/version.rb
+- torckapi.gemspec
+homepage: https://github.com/krupenik/torckapi
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: torckapi is a tool for quering torrent trackers
+test_files: []
+has_rdoc: