torckapi 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e495bbcc0cb11ec0068098e7c26d5df80e6b0993
-  data.tar.gz: 44342f08c1d9e6640a9e7a8c06c6e5397646b031
+  metadata.gz: 23d4a93deca3957dc10d4e056c505b5f57d92bd2
+  data.tar.gz: d4b1fe9fcb70d7ffa604209da48a3018702108dd
 SHA512:
-  metadata.gz: 57f087caa172b88f83df1d6511dd124b2767749357ebdda87b59326edc86eda2f4b305977bcedb8ebd54a8a866b1eb4d05d41daaf37ce359355b649ee3c8fa5a
-  data.tar.gz: dfc8f78453037d1d758985de50f618813eaffeb19b982a6b873133c034b79601e4c91639ac8899ef5ed6940a68bf41eaaef58aeded3f2c4e7e2fa7a8f7a416e1
+  metadata.gz: 2994677c358450c2a6e9a4d3a8ef2ef559e04b30963c37ae2b4ae96a793edef7c78d5abf653b61b3708e9db64c8ff8322bf0752600e3eb48bd1535eee0763851
+  data.tar.gz: 31f3e8806ab54efc32fa48db835f0b7ff1df1d7c64b67aa0908961121c44dddaee734dc022f4ea20d813d7dcef5e6b770fbb963a7506f6015c64c9755a00817b

data/README.md

@@ -36,6 +36,4 @@ tracker.scrape(["0123456789ABCDEF0123456789ABCDEF01234567", "123456789ABCDEF0123
 
 Add tests.
 
-Add HTTP implementation.
-
 Document everything.

data/lib/torckapi/errors.rb

@@ -9,7 +9,7 @@ module Torckapi
     class CommunicationError < Error; end
     class CommunicationFailedError < CommunicationError; end
     class CommunicationTimeoutError < CommunicationError; end
-    class MalformedResponseError < CommunicationError; end
+    class MalformedResponseError < Error; end
     class TransactionIdMismatchError < CommunicationError; end
   end
 end

data/lib/torckapi/response/announce.rb

@@ -1,9 +1,10 @@
 require 'ipaddr'
-require 'bencode'
+require 'torckapi/response/base'
 
 module Torckapi
   module Response
-    class Announce
+    # Announce response
+    class Announce < Base
       # @!attribute [r] info_hash
       #   @return [String] 40-char hexadecimal string
       # @!attribute [r] leechers
@@ -12,6 +13,7 @@ module Torckapi
       #   @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
@@ -25,12 +27,11 @@ module Torckapi
       # Construct response object from http response data
       # @param info_hash [String] 40-char hexadecimal string
       # @param data [String] HTTP response data (bencoded)
-      # @param compact [true, false] is peer data in compact format?
       # @return [Torckapi::Response::Announce] response
-      def self.from_http info_hash, data, compact=true
-        bdecoded_data = BEncode.load(data)
-        raise Torckapi::Tracker::MalformedResponseError unless bdecoded_data.is_a? Hash and bdecoded_data.has_key? 'peers'
-        new info_hash, *bdecoded_data.values_at("incomplete", "complete"), peers_from_compact(bdecoded_data['peers'])
+      # @raise [Torckapi::Tracker::MalformedResponseError]
+      def self.from_http info_hash, data
+        bdecoded_data = bdecode_and_check data, 'peers'
+        new info_hash, *bdecoded_data.values_at('incomplete', 'complete'), peers_from_compact(bdecoded_data['peers'])
       end
 
       private

data/lib/torckapi/response/base.rb

@@ -0,0 +1,21 @@
+require 'bencode'
+
+module Torckapi
+  module Response
+    class Base
+      protected
+
+      def self.bdecode_and_check data, key
+        begin
+          bdecoded_data = BEncode.load(data)
+        rescue BEncode::DecodeError
+          raise Torckapi::Tracker::MalformedResponseError
+        end
+
+        raise Torckapi::Tracker::MalformedResponseError unless bdecoded_data.is_a? Hash and bdecoded_data.has_key? key
+
+        bdecoded_data
+      end
+    end
+  end
+end

data/lib/torckapi/response/error.rb

@@ -1,6 +1,9 @@
+require 'torckapi/response/base'
+
 module Torckapi
   module Response
-    class Error
+    # Error response
+    class Error < Base
       # @!attribute [r] info_hash
       #   @return [String] 40-char hexadecimal string
       # @!attribute [r] info_hashes

data/lib/torckapi/response/scrape.rb

@@ -1,10 +1,9 @@
-require 'bencode'
+require 'torckapi/response/base'
 
 module Torckapi
   module Response
-
     # Scrape response
-    class Scrape
+    class Scrape < Base
       # @return [Hash<String, Hash>] scrape data
       attr_reader :data
 
@@ -12,29 +11,33 @@ module Torckapi
       # @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
+      # @raise [Torckapi::Tracker::MalformedResponseError]
       def self.from_udp info_hashes, data
-        raise Torckapi::MalformedResponseError if data.length != info_hashes.count * 12
+        raise Torckapi::Tracker::MalformedResponseError if data.length != info_hashes.count * 12
         new Hash[info_hashes.zip(data.unpack('a12' * info_hashes.count).map { |i| counts_unpacked(i) })]
       end
 
+      # Construct response object from http response data
+      # @param data [String] HTTP response data (bencoded)
+      # @return [Torckapi::Response::Scrape] response
+      # @raise [Torckapi::Tracker::MalformedResponseError]
       def self.from_http data
-        bdecoded_data = BEncode.load(data)
-        raise Torckapi::MalformedResponseError unless bdecoded_data.is_a? Hash and bdecoded_data.has_key? 'files'
-        new Hash[bdecoded_data["files"].map { |info_hash, counts| [info_hash.unpack('H*').join, counts_translated(counts) ]}]
+        bdecoded_data = bdecode_and_check data, 'files'
+        new Hash[bdecoded_data['files'].map { |info_hash, counts| [info_hash.unpack('H*').join, counts_translated(counts) ]}]
       end
 
       private
 
       def self.counts_unpacked data
-        counts_with_block(data, lambda { |data| data.unpack('L>3').map(&:to_i) })
+        counts_with_block(data) { |data| data.unpack('L>3').map(&:to_i) }
       end
 
       def self.counts_translated data
-        counts_with_block(data, lambda { |data| data.values_at("complete", "downloaded", "incomplete") })
+        counts_with_block(data) { |data| data.values_at('complete', 'downloaded', 'incomplete') }
       end
 
-      def self.counts_with_block data, block
-        Hash[[:seeders, :completed, :leechers].zip(block.call(data))]
+      def self.counts_with_block data, &block
+        Hash[[:seeders, :completed, :leechers].zip(yield data)]
       end
 
       def initialize data

data/lib/torckapi/tracker/base.rb

@@ -3,16 +3,23 @@ module Torckapi
 
     # Public interface for torrent trackers
     class Base
-      # Announce Request
+      # Announce request
       # @param info_hash [String] 40-char hexadecimal string
+      # @param peer_id [String] 20-byte binary string
       # @return [Torckapi::Response::Announce] a response object
-      def announce info_hash
+      # @raise [Torckapi::InvalidInfohashError] when supplied with invalid info_hash
+      # @raise [Torckapi::Tracker::CommunicationFailedError] when tracker haven't responded at all
+      # @raise [Torckapi::Tracker::MalformedResponseError] when tracker returned junk
+      def announce info_hash, peer_id=SecureRandom.random_bytes(20)
         raise Torckapi::InvalidInfohashError if info_hash !~ /\A[0-9a-f]{40}\z/i
       end
 
-      # Scrape Request
+      # Scrape request
       # @param info_hashes [Array<String>] An array of 40-char hexadecimal strings
       # @return [Torckapi::Response::Scrape] a response object
+      # @raise [Torckapi::InvalidInfohashError] when supplied with invalid info_hash
+      # @raise [Torckapi::Tracker::CommunicationFailedError] when tracker haven't responded at all
+      # @raise [Torckapi::Tracker::MalformedResponseError] when tracker returned junk
       def scrape info_hashes=[]
         raise Torckapi::InvalidInfohashError if info_hashes.any? { |i| i !~ /\A[0-9a-f]{40}\z/i }
       end

data/lib/torckapi/tracker/http.rb

@@ -5,8 +5,6 @@ module Torckapi
   module Tracker
 
     class HTTP < Base
-      REQUEST_ACTIONS = [Announce = 1, Scrape = 2].freeze
-
       # (see Base#announce)
       def announce info_hash
         super info_hash
@@ -21,6 +19,8 @@ module Torckapi
 
       private
 
+      REQUEST_ACTIONS = [Announce = 1, Scrape = 2].freeze
+
       def initialize url, options={}
         super url, options
         @url.query ||= ""

data/lib/torckapi/tracker/udp.rb

@@ -5,21 +5,13 @@ require 'torckapi/tracker/base'
 
 module Torckapi
   module Tracker
-
     # Implementation of http://www.bittorrent.org/beps/bep_0015.html
     class UDP < Base
-      CONNECTION_TIMEOUT = 60
-      REQUEST_ACTIONS = [Connect = 0, Announce = 1, Scrape = 2].freeze
-      RESPONSE_CLASSES = [nil, Torckapi::Response::Announce, Torckapi::Response::Scrape, Torckapi::Response::Error].freeze
-      RESPONSE_MIN_LENGTHS = [16, 20, 8, 8].freeze
-
-      # (see Base#announce)
       def announce info_hash, peer_id=SecureRandom.random_bytes(20)
         super info_hash
         perform_request Announce, announce_request_data(info_hash, peer_id), info_hash
       end
 
-      # (see Base#scrape)
       def scrape info_hashes=[]
         super info_hashes
         perform_request Scrape, scrape_request_data(info_hashes), info_hashes
@@ -27,6 +19,11 @@ module Torckapi
 
       private
 
+      CONNECTION_TIMEOUT = 60
+      REQUEST_ACTIONS = [Connect = 0, Announce = 1, Scrape = 2].freeze
+      RESPONSE_CLASSES = [nil, Torckapi::Response::Announce, Torckapi::Response::Scrape, Torckapi::Response::Error].freeze
+      RESPONSE_MIN_LENGTHS = [16, 20, 8, 8].freeze
+
       def perform_request action, data, *args
         connect
         response = communicate action, data

data/lib/torckapi/version.rb

@@ -1,3 +1,3 @@
 module Torckapi
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: torckapi
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Dennis Krupenik
@@ -66,6 +66,7 @@ files:
 - lib/torckapi.rb
 - lib/torckapi/errors.rb
 - lib/torckapi/response/announce.rb
+- lib/torckapi/response/base.rb
 - lib/torckapi/response/error.rb
 - lib/torckapi/response/scrape.rb
 - lib/torckapi/tracker/base.rb