kat 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6ad7f5809e7cfbdc5379f566d93c61a361a51e6
-  data.tar.gz: 852186a99d1af3374c4de52f0bb91c45d3c3a5bc
+  metadata.gz: 2169e0aa1bb57e770b1f18c28c7e303a1d873f91
+  data.tar.gz: ef1a8c23da1ffbf1a178b82a1296bdbd98f42124
 SHA512:
-  metadata.gz: cd2896742673ed05ccec2bd1ec63b2af9498911683a9b21e8ad0a7352d8311a2532f7ef8a26960266e4514d9a5aae979762acd710fde36b252159c74cb41d301
-  data.tar.gz: fc2812d838cc89f103fa9a52e6f2a3ae1345f466d9a732539eb1d26bc6adfa0971ff76961cd7296606aff6b83af9d8fa47639f34b66b2cb17a21905a9477b1a2
+  metadata.gz: 63795bf527fc336114b525c5d0de19bab3cb5079c761fd8261383801a1cf204a2e6079cd54f3e9819ea2e464bb4c434785da21ace8b063cd34d29913f91270bc
+  data.tar.gz: e6be7512cb382544a0614ec6dfce16bb713326412f72b25f877eaf71519b1eb9f47454d68a4691c19e5246594d33f52d69c4cc8a5164f60c819d117514fd08da

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+Guardfile
 InstalledFiles
 _yardoc
 coverage

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 group :test do
   gem 'rake'
+  gem 'minitest', '~> 4.3'
 end

data/README.md

@@ -1,6 +1,8 @@
+[![Build Status](https://secure.travis-ci.org/fissionxuiptz/kat.png)](http://travis-ci.org/fissionxuiptz/kat)
+
 # Kat
 
-TODO: Write a gem description
+A Ruby interface to Kickass Torrents
 
 ## Installation
 
@@ -18,7 +20,48 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Quick search
+
+    Kat.search('game of thrones')
+
+### Search for torrents
+
+    kat = Kat.new('game of thrones', { :category => 'tv' })
+    kat.search
+
+### Specifying pages
+
+Page searching is 0-based. The number of pages is set after a search is performed and returned
+with the `pages` method.
+
+    kat.search(2)             # Third page of results
+    kat.results[0]            # First page of results
+    kat.pages                 # Total number of pages
+
+### Results
+
+The `results` method returns a list of torrent information per page. Each result has
+title, magnet, download, size, files, age, seeds and leeches information. Complete lists
+of each can be returned with:
+
+    kat.titles                # List all titles...
+    kat.downloads             #       ...downloads...
+    kat.seeds                 #       ...seeds etc
+
+### Requerying
+
+The Kat instance can be reused with the `query=` and `options=` methods.
+
+    kat.query = 'hell on wheels'
+    kat.options = { :seeds => 100 }
+
+Either method resets the number of pages and the results cache.
+
+### Executable
+
+In addition to the Kat class, there is also a binary which makes use of the class to do
+some rudimentary searching and downloading of torrents. Invoke `kat --help` to get a
+complete list of options.
 
 ## Contributing
 

data/Rakefile

@@ -5,5 +5,5 @@ task :default => :test
 
 Rake::TestTask.new do |t|
   t.libs.push 'lib'
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/kat/test_*.rb']
 end

data/bin/kat

@@ -1,127 +1,5 @@
 #!/usr/bin/env ruby
 
-e = []
+require File.dirname(__FILE__) + '/../lib/kat/app'
 
-require 'open-uri'
-%w(kat trollop highline).sort.each do |lib|
-  begin
-    require lib
-  rescue LoadError
-    e << lib.sub(/_/, '')
-  end
-end
-
-unless e.empty?
-  puts <<-EOS
-Kickass Torrents Search relies on #{e.join(', ').sub(/^(.*), /, '\1 and ')}. To download the gem#{'s' if e.size > 1} type:
-
-  gem install #{e.join ' '}
-
-EOS
-  exit
-end
-
-VERSION_STR = "#{Kat::NAME} #{Kat::VERSION} (c) 2013 #{Kat::AUTHOR}"
-
-list_args = { :categories => :category, :times      => :added,
-              :languages  => :language, :platforms  => :platform }
-
-options = Trollop::options do
-  version VERSION_STR
-  banner <<-EOS
-#{VERSION_STR}
-
-Usage: #{File.basename __FILE__} [options] <query>+
-
-  Options:
-EOS
-
-  opt :exact,      'Exact phrase',              :type => :string
-  opt :or,         'Optional words',            :type => :string, :multi => true
-  opt :without,    'Without this word',         :type => :string, :multi => true
-
-  opt :sort,       'Sort field (size, files, time_add, seeders, leechers)', :type => :string
-  opt :asc,        'Ascending sort order (descending is default)', :type => :boolean
-
-  opt :added,      'Age of the torrent',        :type => :string, :short => :a
-  opt :category,   'Category',                  :type => :string, :short => :c
-  opt :files,      'Number of files',           :type => :int
-  opt :imdb,       'IMDB ID',                   :type => :int
-  opt :seeds,      'Minimum number of seeders', :type => :int, :short => :s
-  opt :user,       'Uploader',                  :type => :string
-  opt :season,     'Television season',         :type => :int
-  opt :episode,    'Television episode',        :type => :int, :short => :e
-
-  opt :language,   'Language',                  :type => :int
-  opt :platform,   'Game platform',             :type => :int
-
-  opt :safe,       'Family safety filter',      :type => :boolean
-  opt :verified,   'Verified',                  :type => :boolean, :short => :m
-
-  opt :output,     'Directory to save torrents in', :type => :string, :short => :o
-
-  list_args.each {|k, v| opt k, "List the #{k} that may be used with --#{v}", :type => :boolean }
-end
-
-unless list_args.select! {|k, v| options[k] }.empty?
-  puts VERSION_STR
-  list_args.each do |opt, label|
-    args = Kat.send opt
-    puts "\n  #{label.to_s.capitalize}"
-    puts unless args.values.first.is_a? Array
-    args.each {|k, v| puts v.is_a?(Array) ? "\n  %12s => #{v.join "\n\t\t  "}" % k : "  %-23s => #{v}" % k }
-    puts
-  end
-else
-  k = Kat.new ARGV.join(' '), options
-  h = HighLine.new
-  page = 0
-  puts VERSION_STR
-
-  loop do
-    r = k.search page
-    if r.nil?
-      puts "\nNo results"
-      break
-    end
-
-    n = page < k.pages - 1
-    p = page > 0
-
-    puts "\n%-72s S     L\n\n" % "Page #{page + 1} of #{k.pages}"
-    r.each_with_index do |t, i|
-      puts "%2d. %-64s %5d %5d" % [ i + 1, t[:title][0..63], t[:seeds], t[:leeches] ]
-    end
-
-    commands = "[#{'n' if n}#{'p' if p}q]|"
-    _01to09  = "[1#{r.size >  9 ? '-9' : '-' + r.size.to_s}]"
-    _10to19  = "#{r.size   >  9 ? '|1[0-' + (r.size > 19 ? '9' : (r.size - 10).to_s) + ']' : ''}"
-    _20to25  = "#{r.size   > 19 ? '|2[0-' + (r.size - 20).to_s + ']' : ''}"
-    prompt   = "\n1#{r.size > 1 ? '-' + r.size.to_s : ''} to download" +
-               "#{', (n)ext' if n}" +
-               "#{', (p)rev' if p}" +
-               ', (q)uit: '
-
-    case (answer = h.ask(prompt) {|q| q.validate = /^(#{commands}#{_01to09}#{_10to19}#{_20to25})$/ })
-    when 'q' then break
-    when 'n' then page += 1 if n
-    when 'p' then page -= 1 if p
-    else
-      if (1..r.size).include? answer.to_i
-        torrent = k.results[page][answer.to_i - 1]
-        puts "\nDownloading: #{torrent[:title]}"
-
-        begin
-          uri = URI torrent[:download]
-          uri.query = nil
-          response = uri.read
-          file = "#{File.expand_path(options[:output] || '.')}/#{torrent[:title].gsub(/ /, '.').gsub(/[^a-z0-9()_.-]/i, '')}.torrent"
-          File.open(file, 'w') {|f| f.write response }
-        rescue => e
-          puts e.message
-        end
-      end
-    end
-  end
-  puts
-end
+Kat.app

data/lib/kat.rb

@@ -1,247 +1,2 @@
-require 'nokogiri'
-require 'open-uri'
-require 'kat/version'
-
-class Kat
-  KAT_URL = 'http://kickass.to'
-  EMPTY_URL = 'new'
-  SEARCH_URL = 'usearch'
-  ADVANCED_URL = "#{KAT_URL}/torrents/search/advanced/"
-
-  STRING_FIELDS = [ :seeds, :user, :files, :imdb, :season, :episode ]
-
-  # If these are set to anything but nil or false, they're turned on in the query
-  SWITCH_FIELDS = [ :safe, :verified ]
-
-  # The names of these fields are transposed for ease of use
-  SELECT_FIELDS = [ { :name => :categories, :label => :category, :id => :category },
-                    { :name => :times,      :label => :added,    :id => :age },
-                    { :name => :languages,  :label => :language, :id => :lang_id },
-                    { :name => :platforms,  :label => :platform, :id => :platform_id } ]
-
-  SORT_FIELDS   = %w(size files_count time_add seeders leechers)
-
-  # The number of pages of results
-  attr_reader :pages
-
-  # Any error in searching is stored here
-  attr_reader :error
-
-  @@doc = nil
-
-  #
-  # Create a new +Kat+ object to search Kickass Torrents.
-  # The search_term can be nil, a string/symbol, or an array of strings/symbols.
-  # Valid options are in STRING_FIELDS, SELECT_FIELDS or SWITCH_FIELDS.
-  #
-  def initialize search_term = nil, opts = {}
-    @search_term = []
-    @options = {}
-
-    self.query = search_term
-    self.options = opts
-  end
-
-  #
-  # Kat.search will do a quick search and return the results
-  #
-  def self.search search_term
-    self.new(search_term).search
-  end
-
-  #
-  # Generate a query string from the stored options, supplying an optional page number
-  #
-  def query_str page = 0
-    str = [ SEARCH_URL, @query.join(' ').gsub(/[^a-z0-9: _-]/i, '') ]
-    str = [ EMPTY_URL ] if str[1].empty?
-    str << page + 1 if page > 0
-    str << if SORT_FIELDS.include? @options[:sort].to_s
-      "?field=#{options[:sort].to_s}&sorder=#{options[:asc] ? 'asc' : 'desc'}"
-    else
-      ''    # ensure a trailing slash after the search terms or page number
-    end
-    str.join '/'
-  end
-
-  #
-  # Change the search term, triggering a query rebuild and clearing past results.
-  #
-  # Raises ArgumentError if search_term is not a String, Symbol or Array
-  #
-  def query= search_term
-    @search_term = case search_term
-      when nil then []
-      when String, Symbol then [ search_term ]
-      when Array then search_term.flatten.select {|el| [ String, Symbol ].include? el.class }
-      else raise ArgumentError, "search_term must be a String, Symbol or Array. #{search_term.inspect} given."
-    end
-    build_query
-  end
-
-  #
-  # Get a copy of the search options hash
-  #
-  def options
-    @options.dup
-  end
-
-  #
-  # Change search options with a hash, triggering a query string rebuild and
-  # clearing past results.
-  #
-  # Raises ArgumentError if opts is not a Hash
-  #
-  def options= opts
-    raise ArgumentError, "opts must be a Hash. #{opts.inspect} given." unless opts.is_a? Hash
-    @options.merge! opts
-    build_query
-  end
-
-  #
-  # Perform the search, supplying an optional page number to search on. Returns
-  # a result set limited to the 25 results Kickass Torrents returns itself. Will
-  # cache results for subsequent calls of search with the same query string.
-  #
-  def search page = 0
-    unless @results[page] or (@pages > -1 and page >= @pages)
-      begin
-        doc = Nokogiri::HTML(open("#{KAT_URL}/#{URI::encode(query_str page)}"))
-        @results[page] = doc.css('td.torrentnameCell').map do |node|
-          { :title    => node.css('a.normalgrey').text,
-            :magnet   => node.css('a.imagnet').first.attributes['href'].value,
-            :download => node.css('a.idownload').last.attributes['href'].value,
-            :size     => (node = node.next_element).text,
-            :files    => (node = node.next_element).text.to_i,
-            :age      => (node = node.next_element).text,
-            :seeds    => (node = node.next_element).text.to_i,
-            :leeches  => (node = node.next_element).text.to_i }
-        end
-
-        # If we haven't previously performed a search with this query string, get the
-        # number of pages from the pagination bar at the bottom of the results page.
-        @pages = doc.css('div.pages > a').last.text.to_i if @pages < 0
-
-        # If there was no pagination bar and the previous statement didn't trigger
-        # a NoMethodError, there are results but only 1 page worth.
-        @pages = 1 if @pages <= 0
-      rescue NoMethodError
-        # The results page had no pagination bar, but did return some results.
-        @pages = 1
-      rescue => e
-        # No result throws a 404 error.
-        @pages = 0 if e.class == OpenURI::HTTPError and e.message['404 Not Found']
-        @error = { :error => e, :query => query_str(page) }
-      end
-    end
-
-    results[page]
-  end
-
-  #
-  # For message chaining
-  #
-  def do_search page = 0
-    search page
-    self
-  end
-
-  #
-  # Get a copy of the results
-  #
-  def results
-    @results.dup
-  end
-
-  #
-  # If method_sym is a field name in SELECT_FIELDS, we can fetch the list of values.
-  #
-  def self.respond_to? method_sym, include_private = false
-    SELECT_FIELDS.find {|field| field[:name] == method_sym } ? true : super
-  end
-
-  #
-  # If method_sym or its plural is a field name in the results list, this will tell us
-  # if we can fetch the list of values. It'll only happen after a successful search.
-  #
-  def respond_to? method_sym, include_private = false
-    if not (@results.empty? or @results.last.empty?) and
-           (@results.last.first[method_sym] or @results.last.first[method_sym.to_s.chop.to_sym])
-      return true
-    end
-    super
-  end
-
-private
-
-  #
-  # Clear out the query and rebuild it from the various stored options. Also clears out the
-  # results set and sets pages back to -1
-  #
-  def build_query
-    @query = @search_term.dup
-    @pages = -1
-    @results = []
-
-    @query << "\"#{@options[:exact]}\"" if @options[:exact]
-    @query << @options[:or].join(' OR ') unless @options[:or].nil? or @options[:or].empty?
-    @query += @options[:without].map {|s| "-#{s}" } if @options[:without]
-
-    STRING_FIELDS.each {|f| @query << "#{f}:#{@options[f]}" if @options[f] }
-    SWITCH_FIELDS.each {|f| @query << "#{f}:1" if @options[f] }
-    SELECT_FIELDS.each do |f|
-      if (@options[f[:label]].to_s.to_i > 0 and f[:id].to_s['_id']) or
-         (@options[f[:label]] and not f[:id].to_s['_id'])
-        @query << "#{f[:id]}:#{@options[f[:label]]}"
-      end
-    end
-  end
-
-  #
-  # Get a list of options for a particular selection field from the advanced search form
-  #
-  # Raises an error unless the label is in SELECT_FIELDS
-  #
-  def self.field_options label
-    begin
-      raise 'Unknown search field' unless SELECT_FIELDS.find {|f| f[:label] == label.to_sym }
-
-      opts = (@@doc ||= Nokogiri::HTML(open(ADVANCED_URL))).css('table.formtable td').find do |e|
-        e.text[/#{label.to_s}/i]
-      end.next_element.first_element_child.children
-
-      unless (group = opts.css('optgroup')).empty?
-        # Categories
-        group.inject({}) {|c, og| c[og.attributes['label'].value] = og.children.map {|o| o.attributes['value'].value }; c }
-      else
-        # Times, languages, platforms
-        opts.reject {|o| o.attributes.empty? }.inject({}) {|p, o| p[o.text] = o.attributes['value'].value; p }
-      end
-    rescue => e
-      { :error => e }
-    end
-  end
-
-  #
-  # If method_sym is a field name in SELECT_FIELDS, fetch the list of values.
-  #
-  def self.method_missing method_sym, *args, &block
-    if respond_to? method_sym
-      return self.field_options SELECT_FIELDS.find {|field| field[:name] == method_sym }[:label]
-    end
-    super
-  end
-
-  #
-  # If method_sym or its plural form is a field name in the results list, fetch the list of values.
-  # Can only happen after a successful search.
-  #
-  def method_missing method_sym, *args, &block
-    if respond_to? method_sym
-      # Don't need no fancy schmancy singularizing method. Just try chopping off the 's'.
-      return @results.compact.map {|rs| rs.map {|r| r[method_sym] || r[method_sym.to_s.chop.to_sym] } }.flatten
-    end
-    super
-  end
-
-end
+require File.dirname(__FILE__) + '/kat/search'
+require File.dirname(__FILE__) + '/kat/version'