the_pirate_bay 0.0.2 → 0.0.3

data/README.md

@@ -1,4 +1,4 @@
-# ThePirateBay
+# ThePirateBay [![Build Status](https://secure.travis-ci.org/jassa/the_pirate_bay.png?branch=master)](https://travis-ci.org/jassa/the_pirate_bay) [![Dependency Status](https://gemnasium.com/jassa/the_pirate_bay.png)](https://gemnasium.com/jassa/the_pirate_bay) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jassa/the_pirate_bay)
 
 Ruby Client for ThePirateBay.se
 
@@ -16,7 +16,29 @@ And then execute:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "the_pirate_bay"
+
+api = ThePirateBay.new
+
+# You can search for a torrent by keyword
+api.series.search("Fringe")
+=> [#<ThePirateBay::Torrent::Collection id: "7810640", name: "Fringe S05E06 Season 5 Episode 6 HDTV x264 [GlowGaz...", seeders: "408", leechers: "116", magnet_uri: "magnet:?xt=urn:btih:0f4e3c1a4618b6d9658427e7778c602...", size: "303.89 MB", type: "Video > TV shows", uploaded_at: "Today 04:11, Size 303.89 MiB", comments_count: "2", uploader: "GlowGaze">]
+
+# Once you have a torrent id, you can use it to find more information
+torrent = api.torrents.find("7810640")
+```
+
+## Work in Progress
+
+* Find torrents by id
+* Handle users
+* Sort results by relevance, seeders, leechers, size, date, user and type
+* Get results from other pages
+
+## Motivation
+
+ThePirateBay.se is a very powerful engine, and it requires a powerful and specialized gem that can handle all it has to offer, seamlessly.
 
 ## Contributing
 

data/lib/the_pirate_bay.rb

@@ -1,3 +1,4 @@
+require "the_pirate_bay/errors"
 require "the_pirate_bay/version"
 require "the_pirate_bay/api"
 require "the_pirate_bay/model"

data/lib/the_pirate_bay/client.rb

@@ -1,4 +1,5 @@
 require "the_pirate_bay/torrent"
+require "the_pirate_bay/torrent/collection"
 
 module ThePirateBay
   class Client < API

data/lib/the_pirate_bay/connection.rb

@@ -1,4 +1,6 @@
 require "faraday"
+require "the_pirate_bay/response"
+require "the_pirate_bay/response/htmlize"
 
 module ThePirateBay
   module Connection
@@ -10,6 +12,7 @@ module ThePirateBay
       @connection ||= Faraday.new(:url => ThePirateBay::ENDPOINT) do |faraday|
         faraday.response :logger if ENV['DEBUG'] # log requests to STDOUT
         faraday.adapter  :net_http # make requests with NetHTTP
+        faraday.use      ThePirateBay::Response::Htmlize
       end
     end
     

data/lib/the_pirate_bay/errors.rb

@@ -0,0 +1,18 @@
+module ThePirateBay
+
+  # Generic ThePirateBay exception class.
+  class ThePirateBayError < StandardError
+  end
+
+  # Raised when a connection to the api can't be established.
+  class ConnectionNotEstablished < StandardError
+  end
+
+  # Raised when the record was not found given an id or set of ids.
+  class RecordNotFound < StandardError
+  end
+
+  # Raised when unknown attributes are supplied via mass assignment.
+  class UnknownAttributeError < NoMethodError
+  end
+end

data/lib/the_pirate_bay/model.rb

@@ -11,7 +11,7 @@ module ThePirateBay
     def attributes=(params=nil)
       params.each do |attr, value|
         begin
-          self.public_send("#{klass::ATTRS_MAP.key(attr)}=", value)
+          self.public_send("#{attr}=", value)
         rescue NoMethodError
           raise UnknownAttributeError, "unknown attribute: #{attr}"
         end
@@ -20,7 +20,7 @@ module ThePirateBay
     
     def attributes
       attrs = {}
-      klass::ATTRS_MAP.keys.each do |name|
+      class_attributes.each do |name|
         attrs[name] = send(name)
       end
       attrs
@@ -28,7 +28,7 @@ module ThePirateBay
     
     def inspect
       inspection = unless id.nil?
-        klass::ATTRS_MAP.keys.collect { |name|
+        class_attributes.collect { |name|
           "#{name}: #{attribute_for_inspect(name)}"
         }.compact.join(", ")
        else
@@ -49,5 +49,9 @@ module ThePirateBay
       end
     end
     
+    def class_attributes
+      klass::ATTRS
+    end
+    
   end # Model
 end # ThePirateBay

data/lib/the_pirate_bay/response.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+module ThePirateBay
+  # Contains methods and attributes that act on the response returned from the 
+  # request
+  class Response < Faraday::Response::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    class << self
+      attr_accessor :parser
+    end
+    
+    def self.define_parser(&block)
+      @parser = block
+    end
+
+    def response_type(env)
+      env[:response_headers][CONTENT_TYPE].to_s
+    end
+
+    def parse_response?(env)
+      env[:body].respond_to? :to_str
+    end    
+    
+  end # Response
+end # ThePirateBay

data/lib/the_pirate_bay/response/htmlize.rb

@@ -0,0 +1,19 @@
+module ThePirateBay
+  class Response::Htmlize < Response
+    dependency 'nokogiri'
+    
+    define_parser do |body|
+      ::Nokogiri::HTML body
+    end
+
+    def parse(body)
+      case body
+      when String
+        self.class.parser.call body
+      else
+        body
+      end
+    end
+    
+  end # Response::Htmlize
+end # ThePirateBay

data/lib/the_pirate_bay/torrent.rb

@@ -9,7 +9,14 @@ module ThePirateBay
 
     class << self
       def search(query)
-        data = request("search/#{query}/0/99/0")
+        # Returns search html
+        doc = request("search/#{query}/0/99/0")
+
+        # Get torrents table rows 
+        # and return as ruby objects
+        doc.xpath("//table[@id='searchResult']/tr").collect do |torrent|
+          Torrent::Collection.new(torrent)
+        end
       end
       
       def find(id)
@@ -17,6 +24,6 @@ module ThePirateBay
       end
       alias :get :find
     end
-            
+    
   end # Torrent
 end # ThePirateBay

data/lib/the_pirate_bay/torrent/collection.rb

@@ -0,0 +1,64 @@
+module ThePirateBay
+  class Torrent::Collection
+    include Model
+    
+    ATTRS = [:id, :name, :seeders, :leechers, :magnet_uri,
+      :size, :type, :uploaded_at, :comments_count, :uploader].freeze
+    
+    attr_accessor *ATTRS, :torrent
+    
+    def initialize(torrent)
+      @torrent = torrent
+      class_attributes.collect do |attr|
+        self.public_send("#{attr}=", send(attr))
+      end
+    end
+    
+    def class_attributes
+      ATTRS
+    end
+
+    def id
+      torrent.css('td[2] div.detName').inner_html.match(/\/torrent\/(\d+)\//)[1]
+    end
+    
+    def name
+      torrent.css('td[2] div.detName a').text
+    end
+    
+    def type
+      torrent.css('td[1] a').map(&:text).join(" > ")
+    end
+    
+    def size
+      torrent.css('td[2] font.detDesc').text.match(/Size (.*),/)[1].gsub('i', '')
+    end
+    
+    def seeders
+      torrent.css('td[3]').text
+    end
+    
+    def leechers
+      torrent.css('td[4]').text
+    end
+    
+    def uploader
+      torrent.css('td[2] font.detDesc a').text
+    end
+    
+    def magnet_uri
+      torrent.css('td[2] div.detName + a').attribute("href").value
+    end
+    
+    def comments_count
+      unless (comments = torrent.css('td[2] img[@src*="comment.gif"]')).empty?
+        comments.attribute("alt").value.match(/\d+/)[0]
+      end
+    end
+    
+    def uploaded_at
+      torrent.css('td[2] font.detDesc').text.match(/Uploaded (.*),/)[1]
+    end
+    
+  end # Torrent::Collection
+end # ThePirateBay

data/lib/the_pirate_bay/version.rb

@@ -1,3 +1,3 @@
 module ThePirateBay
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/the_pirate_bay/torrent_spec.rb

@@ -3,14 +3,24 @@ require "spec_helper"
 describe ThePirateBay::Torrent do
   let(:api) { ThePirateBay.new }
     
-  context ".search" do
-    it "returns html torrents results" do
-      api.torrents.search("Fringe").should include("Fringe")
+  context ".search", focus: true do
+    let(:torrents) { api.torrents.search("Fringe") }
+    
+    it "returns torrents results" do
+      torrents.class.should == Array
+    end
+    
+    it "instantiates torrents collection objects" do
+      torrents.first.class.should == ThePirateBay::Torrent::Collection
+    end
+    
+    it "assigns torrents attributes" do
+      torrents.first.id.should == "7811310"
     end
   end
   
   context ".find" do
-    it "returns a particular torrent html" do
+    it "returns a particular torrent" do
       api.torrents.find("7723168").should include("Fringe S05E03 HDTV")
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_pirate_bay
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70282189528700 !ruby/object:Gem::Requirement
+  requirement: &70181583441780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70282189528700
+  version_requirements: *70181583441780
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70282189528200 !ruby/object:Gem::Requirement
+  requirement: &70181583469940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.5
   type: :runtime
   prerelease: false
-  version_requirements: *70282189528200
+  version_requirements: *70181583469940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70282189527740 !ruby/object:Gem::Requirement
+  requirement: &70181583469480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70282189527740
+  version_requirements: *70181583469480
 description: Ruby Client for ThePirateBay.se
 email:
 - javier@tractical.com
@@ -62,8 +62,12 @@ files:
 - lib/the_pirate_bay/api.rb
 - lib/the_pirate_bay/client.rb
 - lib/the_pirate_bay/connection.rb
+- lib/the_pirate_bay/errors.rb
 - lib/the_pirate_bay/model.rb
+- lib/the_pirate_bay/response.rb
+- lib/the_pirate_bay/response/htmlize.rb
 - lib/the_pirate_bay/torrent.rb
+- lib/the_pirate_bay/torrent/collection.rb
 - lib/the_pirate_bay/version.rb
 - spec/spec_helper.rb
 - spec/the_pirate_bay/torrent_spec.rb