subscene 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+only:
+  - master
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in subscene.gemspec
 gemspec
+
+group :test do
+  gem 'rake'
+end

data/README.md

@@ -1,7 +1,14 @@
-# Subscene
+# Subscene [![Build Status](https://travis-ci.org/jassa/subscene.png)](https://travis-ci.org/jassa/subscene)
 
 Ruby API Client for Subscene.com
 
+## Introduction
+
+Subscene.com is a very complete and reliable catalog of subtitles.
+If you're reading this you probably know they don't have an API.
+
+This gem will help you communicate with Subscene.com easily.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,9 +23,51 @@ Or install it yourself as:
 
     $ gem install subscene
 
-## Usage
+## Searching
+
+Subscene.com handles two kinds of searches:
+
+1.    Search by Film or TV Show 'title'
+
+      e.g. "The Big Bang Theory", "The Hobbit", etc.
+
+2.    Search for a particular 'release'
+
+      e.g. "The Big Bang Theory s01e01" or "The Hobbit HDTV"
+
+There are certain keywords that trigger one search or the other,
+this gem initially will support the second type (by release)
+so make sure to format your queries properly.
+
+## Examples
+
+The `search` method  will return subtitles that match the query.
+
+    Subscene.search('The Big Bang Theory s01e01')
+    # => [#<Subscene::SubtitleResult @attributes={:id=>"136037", :name=>"The.Big.Bang.Theory..",
+          #<Subscene::SubtitleResult @attributes={:id=>"138042", :name=>"The Big Bang.."]
+
+Once you get the results, you can iterate over them and review your options.
+
+The information within these results is limited to what the Subscene.com
+search reveals: http://subscene.com/subtitles/release.aspx?q=the%20big%20bang%20theory%20s01e01
+
+You can obtain additional information by `find`ing the id.
+
+    Subscene.find(subtitles.last.id) # or Subscene.find(151582) directly
+    => #<Subscene::Subtitle @id="151582", @name="Fringe.S01E01.DVDSCR.XviD-MEDiEVAL-EN", @lang="English", @user="Jap", @user_id="20904", @comment="Has no comment.", @rating="8", @downloads="9,549", @framerate="Not available", @created_at="6/18/2008 3:09 PM", @download_url="/subtitle/download?mac=yoPjbFZ9WFbUmWTWpOvaGbXDYN2b4yBreI8TJIBfpdynT-4hzba446VvrVyxamBM0", @hearing_impaired=false>
+
+## Language Preferences
+
+You can set the language id for the search filter.
+Ids can be found at http://subscene.com/filter.
+Maximum 3, comma separated.
 
-TODO: Write usage instructions here
+    # Examples
+    Subscene.language = 13 # English
+    Subscene.search("...") # Results will be only English subtitles
+    Subscene.language = "13,38" # English, Spanish
+    ...
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |r|
+  r.verbose = false
+end
+
+task :default => :spec

data/lib/subscene.rb

@@ -1,5 +1,107 @@
+require "faraday"
+require "nokogiri"
+
 require "subscene/version"
+require "subscene/error"
+require "subscene/response"
+require "subscene/response/raise_error"
+require "subscene/response/html"
+require "subscene/subtitle_result_set"
+require "subscene/subtitle"
 
 module Subscene
-  # Your code goes here...
+
+  # Subscene.com is a very complete and reliable catalog of subtitles.
+  # If you're reading this you probably know they don't have an API.
+  #
+  # This gem will help you communicate with Subscene.com easily.
+  #
+  # == Searches
+  #
+  # Subscene.com handles two kinds of searches:
+  #
+  #   a) Search by Film or TV Show 'title'
+  #   e.g. "The Big Bang Theory", "The Hobbit", etc.
+  #
+  #   b) Search for a particular 'release'
+  #   e.g. "The Big Bang Theory s01e01" or "The Hobbit HDTV"
+  #
+  # There are certain keywords that trigger one search or the other,
+  # this gem initially will support the second type (by release)
+  # so make sure to format your queries properly.
+  #
+  extend self
+
+  ENDPOINT     = "http://subscene.com"
+  RELEASE_PATH = "subtitles/release.aspx"
+
+  # Public: Search for a particular release.
+  #
+  # query - The String to be found.
+  #
+  # Examples
+  #
+  #   Subscene.search('The Big Bang Theory s01e01')
+  #   # => [#<Subscene::SubtitleResult:0x007feb7c9473b0
+  #     @attributes={:id=>"136037", :name=>"The.Big.Bang.Theory.."]
+  #
+  # Returns the Subtitles found.
+  def search(query=nil)
+    params = { q: query } unless query.nil?
+    params ||= {}
+
+    response = connection.get do |req|
+      req.url RELEASE_PATH, params
+      req.headers['Cookie'] = "LanguageFilter=#{@lang_id};" if @lang_id
+    end
+
+    html = response.body
+    SubtitleResultSet.build(html).instances
+  end
+
+  # Public: Find a subtitle by id.
+  #
+  # id - The id of the subtitle.
+  #
+  # Examples
+  #
+  #   Subscene.find(136037)
+  #   # => TODO: display example result
+  #
+  # Returns the complete information of the Subtitle.
+  def find(id)
+    response = connection.get(id.to_s)
+    html     = response.body
+
+    subtitle = Subtitle.build(html)
+    subtitle.id = id
+    subtitle
+  end
+
+  # Public: Set the language id for the search filter.
+  #
+  # lang_id - The id of the language. Maximum 3, comma separated.
+  #           Ids can be found at http://subscene.com/filter
+  #
+  # Examples
+  #
+  #   Subscene.language = 13 # English
+  #   Subscene.search("...") # Results will be only English subtitles
+  #   Subscene.language = "13,38" # English, Spanish
+  #   ...
+  #
+  def language=(lang_id)
+    @lang_id = lang_id
+  end
+
+  private
+
+  def connection
+    @connection ||= Faraday.new(url: ENDPOINT) do |faraday|
+      faraday.response :logger if ENV['DEBUG']
+      faraday.adapter  Faraday.default_adapter
+      faraday.use      Subscene::Response::HTML
+      faraday.use      Subscene::Response::RaiseError
+    end
+  end
 end

data/lib/subscene/error.rb

@@ -0,0 +1,3 @@
+module Subscene
+  class SearchNotSupported < StandardError; end
+end

data/lib/subscene/response.rb

@@ -0,0 +1,22 @@
+module Subscene
+  class Response < Faraday::Response::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    class << self
+      attr_accessor :parser
+    end
+
+    # Store a Proc that receives the body and returns the parsed result.
+    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
+end

data/lib/subscene/response/html.rb

@@ -0,0 +1,20 @@
+module Subscene
+  class Response::HTML < 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::HTML
+end # Subscene

data/lib/subscene/response/raise_error.rb

@@ -0,0 +1,20 @@
+module Subscene
+  class Response::RaiseError < Faraday::Response::Middleware
+    ClientErrorStatuses = 400...600
+
+    def on_complete(env)
+      case env[:status]
+      when 301, 302
+        raise Subscene::SearchNotSupported, response_values(env)
+      end
+    end
+
+    def response_values(env)
+      {
+        :status  => env[:status],
+        :headers => env[:response_headers],
+        :body    => env[:body]
+      }
+    end
+  end
+end

data/lib/subscene/subtitle.rb

@@ -0,0 +1,56 @@
+class Subscene::Subtitle
+
+  attr_accessor :attributes, :id, :name, :lang, :user, :user_id, :comment, :rating,
+    :downloads, :download_url, :framerate, :created_at, :hearing_impaired
+
+  def initialize(attributes = {})
+    @attributes = attributes
+    @id         = @attributes[:id]
+    @name       = @attributes[:name]
+    @lang       = @attributes[:lang]
+    @user       = @attributes[:user]
+    @user_id    = @attributes[:user_id]
+    @comment    = @attributes[:comment]
+    @rating     = @attributes[:rating]
+    @downloads  = @attributes[:downloads]
+    @framerate  = @attributes[:framerate]
+    @created_at = @attributes[:created_at]
+    @download_url = @attributes[:download_url]
+    @hearing_impaired = @attributes[:hearing_impaired]
+  end
+
+
+  # Public: Download a Subtitle file.
+  #
+  # Examples
+  #
+  #   Subscene.find(136037).download
+  #   # => #<Faraday::Response #@env={:body=>"PK\u00...",
+  #     :response_headers=>{"content-type"=>"application/x-zip-compressed"} [..]>
+  #
+  # Returns a Faraday::Response instance.
+  def download
+    conn = Faraday.new(url: Subscene::ENDPOINT)
+    conn.post do |req|
+      req.url download_url
+      req.headers['Referer'] = "#{Subscene::ENDPOINT}/#{id}"
+    end
+  end
+
+  def self.build(html)
+    new({
+      id: (html.css("nav.comment-sub a").to_s.match(/subtitleId=(\d+)/)[1] rescue nil),
+      name: (html.css("li.release").children.last.text.strip rescue nil),
+      lang: (html.css("a#downloadButton").text.match(/Download (.*)\n/)[1] rescue nil),
+      user: (html.css("li.author").text.strip rescue nil),
+      user_id: (html.css("li.author a").attribute("href").value.match(/\d+/).to_s rescue nil),
+      comment: (html.css("div.comment").text.strip rescue nil),
+      rating: (html.css("div.rating").text.strip rescue nil),
+      downloads: (html.css("div.details li[contains('Downloads')]").children.last.text.strip rescue nil),
+      framerate: (html.css("div.details li[contains('Framerate')]").children.last.text.strip rescue nil),
+      created_at: (html.css("div.details li[contains('Online')]").children.last.text.strip rescue nil),
+      download_url: (html.css("a#downloadButton").attr("href").value rescue nil),
+      hearing_impaired: (html.css("div.details li[contains('Hearing')]").children.last.text.strip != "No" rescue nil)
+    })
+  end
+end

data/lib/subscene/subtitle_result.rb

@@ -0,0 +1,35 @@
+class Subscene::SubtitleResult
+
+  attr_accessor :attributes, :id, :name, :url, :lang,
+    :user, :user_id, :comment, :files_count, :hearing_impaired
+
+  def initialize(attributes)
+    @attributes = attributes
+
+    @id      = @attributes[:id]
+    @name    = @attributes[:name]
+    @url     = @attributes[:url]
+    @lang    = @attributes[:lang]
+    @user    = @attributes[:user]
+    @user_id = @attributes[:user_id]
+    @comment = @attributes[:comment]
+    @files_count = @attributes[:files_count]
+    @hearing_impaired = @attributes[:hearing_impaired]
+  end
+
+  def self.build(html)
+    subtitle_url = (html.css("td.a1 a").attribute("href").value rescue nil)
+
+    new({
+      id:      (subtitle_url.match(/\d+$/).to_s rescue nil),
+      name:    (html.css("td.a1 span[2]").text.strip rescue nil),
+      url:     subtitle_url,
+      lang:    (html.css("td.a1 span[1]").text.strip rescue nil),
+      user:    (html.css("td.a5").text.strip rescue nil),
+      user_id: (html.css("td.a5 a").attribute("href").value.match(/\d+/).to_s rescue nil),
+      comment: (html.css("td.a6").text.strip rescue nil),
+      files_count: (html.css("td.a3").text.to_i rescue nil),
+      hearing_impaired: html.at_css("td.a40").nil?
+    })
+  end
+end

data/lib/subscene/subtitle_result_set.rb

@@ -0,0 +1,19 @@
+require "subscene/subtitle_result"
+
+class Subscene::SubtitleResultSet
+  attr_reader :instances
+
+  def initialize(attributes)
+    @instances = attributes[:instances]
+  end
+
+  def self.build(html)
+    instances = html.css("tbody > tr").collect do |item|
+      Subscene::SubtitleResult.build(item)
+    end
+
+    new({
+      instances: instances
+    })
+  end
+end

data/lib/subscene/version.rb

@@ -1,3 +1,3 @@
 module Subscene
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/result_sample.html

@@ -0,0 +1,31 @@
+<tr>
+  <td class="a1">
+    <a href="/subtitles/the-big-bang-theory-first-season/english/136037">
+      <div class="visited">
+        <span class="l r positive-icon">
+          English
+          </span>
+        <span>
+          The.Big.Bang.Theory.S01E01-08.HDTV.XviD-XOR 
+          </span>
+        </div>
+      </a>
+    </td>
+  <td class="a3">
+    8
+    </td>
+  <td class="a40">
+    &nbsp;
+    </td>
+  <td class="a5">
+
+    <a href="/u/26733">
+      rogard
+      </a>
+    </td>
+  <td class="a6">
+    <div>
+      Episodes 1 to 8&nbsp;
+      </div>
+    </td>
+  </tr>

data/spec/fixtures/result_set_sample.html

@@ -0,0 +1,96 @@
+<tbody>
+  <tr>
+    <td class="a1">
+      <a href="/subtitles/the-big-bang-theory-first-season/english/136037">
+        <div class="visited">
+          <span class="l r positive-icon">
+            English
+            </span>
+          <span>
+            The.Big.Bang.Theory.S01E01-08.HDTV.XviD-XOR 
+            </span>
+          </div>
+        </a>
+      </td>
+    <td class="a3">
+      8
+      </td>
+    <td class="a40">
+      &nbsp;
+      </td>
+    <td class="a5">
+
+      <a href="/u/26733">
+        rogard
+        </a>
+      </td>
+    <td class="a6">
+      <div>
+        Episodes 1 to 8&nbsp;
+        </div>
+      </td>
+    </tr>
+
+  <tr>
+    <td class="a1">
+      <a href="/subtitles/the-big-bang-theory-first-season/english/171327">
+        <div class="visited">
+          <span class="l r positive-icon">
+            English
+            </span>
+          <span>
+            The.Big.Bang.Theory.S01.DVDRop.XviD-FoV 
+            </span>
+          </div>
+        </a>
+      </td>
+    <td class="a3">
+      17
+      </td>
+    <td class="a41">
+      &nbsp;
+      </td>
+    <td class="a5">
+      <a href="/u/93617">
+        ray148
+        </a>
+      </td>
+    <td class="a6">
+      <div>
+        &nbsp;
+        </div>
+      </td>
+    </tr>
+
+  <tr>
+    <td class="a1">
+      <a href="/subtitles/the-big-bang-theory-second-season/english/173831">
+        <div class="visited">
+          <span class="l r positive-icon">
+            English
+            </span>
+          <span>
+            The.Big.Bang.Theory.S02E02.HDTV.XviD-DOT [Edited] 
+            </span>
+          </div>
+        </a>
+      </td>
+    <td class="a3">
+      1
+      </td>
+    <td class="a40">
+      &nbsp;
+      </td>
+    <td class="a5">
+
+      <a href="/u/51235">
+        verdikt
+        </a>
+      </td>
+    <td class="a6">
+      <div>
+        The edited version of S02E02. Enjoi :)&nbsp;
+        </div>
+      </td>
+    </tr>
+  </tbody>