undertexter 0.1.0 → 0.1.1

data/README.markdown

@@ -1,16 +1,20 @@
-What is Undertexter?
-===============
+# Undertexter
+## What is Undertexter?
 
 Undertexter provides a basic search client that makes it possible to search for swedish and english subtitles on [Undertexter.se](http://undertexter.se)
 
-How to use
-===============
+*Support for other subtitles sites will be added in the future. Follow this project to know when*
+
+## How to use
+
+### Find a subtitle based on any string
 
 The find methods takes any string, including an IMDB id.
-This is how to use it in irb.
+This is how to use it in `irb`.
 
     $ require 'undertexter'
     # => true
+    
     $ subtite = Undertexter.find("tt0840361").first
     => #<Subtitle:0x1020fff98 @downloads=8328, @movie_title="The Town", @title="The.Town.2010....BRRip", @url="http://www.undertexter.se/?p=undertext&id=23711", @cds=1>
     $ subtitle.downloads
@@ -23,24 +27,25 @@ This is how to use it in irb.
     = "http://www.undertexter.se/utext.php?id=23711"
     $ subtitle.details
     => "http://www.undertexter.se/?p=undertext&id=23711"
+    
     $ Undertexter.find("die hard").count
     => 41
 
-You can also provide an language option.
+### Find a subtitle with in centrain language
     
     $ Undertexter.find("tt0840361", :language => :english).count
     => 48
     $ Undertexter.find("tt0840361", :language => :swedish).count
     => 8
 
-Download the subtitle to disk
+### Download the subtitle to disk
 
     $ Undertexter.find("tt0840361").first.download!
     => "/tmp/The.Town.2010.EXTENDED.480p.BRRip.XviD-NYDIC.rar"
     $ File.exists?("/tmp/The.Town.2010.EXTENDED.480p.BRRip.XviD-NYDIC.rar")
     => true
     
-You can also specify a destination folder to download the file, both relative and absolute
+### Download the subtitle to a specified destination folder, both relative and absolute
     
     $ Undertexter.find("tt0840361").first.download!(:to => /some/dir)
     => "/some/dir/The.Town.2010.EXTENDED.480p.BRRip.XviD-NYDIC.rar"
@@ -50,14 +55,14 @@ You can also specify a destination folder to download the file, both relative an
     $ Undertexter.find("tt0840361").first.download!(:to => 'my_dir')
     => "/Users/linus/Downloads/my_dir/The.Town.2010.EXTENDED.480p.BRRip.XviD-NYDIC.rar"
     
-Find the right subtitle based on the release name of the movie
+### Find the right subtitle based on the **release name** of the movie
     
     $ Undertexter.find("tt0840361").based_on("The Town EXTENDED 2010 480p BRRip XviD AC3 FLAWL3SS")
     => #<Subtitle:0x00000101b739d0 @cds=1, @downloads=1644, @title="The.Town.EXTENDED.2010.480p.BRRip.XviD.AC3-FLAWL3SS", @details="http://www.undertexter.se/?p=undertext&id=23752", @movie_title="The Town", @language=:swedish>
     
-Specify how sensitive the `based_on` method should be, where `0` is a perfect match and `1` is dont care. Default is 0.4
+### Specify how sensitive the `based_on` method should be, from `0.0` to `1.1`
     
-    $ Undertexter.find("tt0840361").based_on("The Town EXTENDED 2010 480p BRRip XviD AC3 FLAWL3SS", limit: 0)
+    $ Undertexter.find("tt0840361").based_on("The Town EXTENDED 2010 480p BRRip XviD AC3 FLAWL3SS", limit: 0.0)
     => nil
     
     $ Undertexter.find("tt0840361").based_on("The Town EXTENDED 2010 480p BRRip XviD AC3 FLAWL3SS", limit: 0.4)
@@ -65,11 +70,8 @@ Specify how sensitive the `based_on` method should be, where `0` is a perfect ma
     
     $ Undertexter.find("tt0840361").based_on("The.Town.EXTENDED.2010.480p.BRRip.XviD.AC3-FLAWL3SS", limit: 0.0)
     => #<Subtitle:0x00000101b8d718 @cds=1, @downloads=1644, @title="The.Town.EXTENDED.2010.480p.BRRip.XviD.AC3-FLAWL3SS", @details="http://www.undertexter.se/?p=undertext&id=23752", @movie_title="The Town", @language=:swedish>
-    
-If no language option is being passed to find, it will fall back to swedish
 
-What is being returned from the find method?
-===============
+## What is being returned?
 
 The find method returns an `Array` with zero or more subtitles. Every subtitle provides some basic accessors.
 
@@ -79,26 +81,37 @@ The find method returns an `Array` with zero or more subtitles. Every subtitle p
 - `downloads` (Integer) The amount of downloads for this particular subtitle.
 - `url` (String) A direct link to the subtitle file, a rar file for example
 - `details` (String) A link to the details page for the subtitle
+- `download!` (String) The absolut path to the downloaded subtitle
+
+## Some optional options 
+
+### The `find` method
+
+- **:language** (Symbol) The language of the subtitle. Default is `:swedish`, the other option is `:english`.
+
+### The `download!` method on the subtitle object
+
+- **:to** (String) The absolut or relative path to where the downloaded file will be placed. Default is `/tmp`
+
+### The `based_on` method on any array that is being returned from `Undertexter`
+
+- **:limit** (Float) The sensitivity of the method, where `0.0` is a perfect match and `1.0` is don't care. If this is set to high the method will return nil. Default is `0.4`. Read more about the [levenshtein](http://en.wikipedia.org/wiki/Levenshtein_distance) algorithm that is being used [here](http://www.erikveen.dds.nl/levenshtein/doc/index.html).
 
-How to install
-===============
+## How to install
 
-    sudo gem install undertexter
+    [sudo] gem install undertexter
     
-How to use it in a rails 3 project
-===============
+## How to use it in a rails 3 project
 
 Add `gem 'undertexter'` to your Gemfile and run `bundle`.
 
-How to help
-===============
+## How to help
 
 - Start by copying the project or make your own branch.
 - Navigate to the root path of the project and run `bundle`.
 - Start by running all tests using rspec, `rspec spec/undertexter_spec.rb`.
 - Implement your own code, write some tests, commit and do a pull request.
 
-Requirements
-===============
+## Requirements
 
 Undertexter is tested in OS X 10.6.6 using Ruby 1.8.7.

data/spec/array_spec.rb

@@ -30,4 +30,14 @@ describe Array do
   it "should return nil if trying to fetch an non existing imdb id" do
     Undertexter.find("tt123456789").based_on("some random argument").should be_nil
   end
+  
+  it "should raise an exception when the array does not contain any subtitle objects" do
+    lambda {
+      [1,2,2,3].based_on("some args")
+    }.should raise_error(NoMethodError)
+  end
+  
+  it "should be an array" do
+    @subtitles.should be_an_instance_of(Array)
+  end
 end

data/undertexter.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "undertexter"
-  s.version     = "0.1.0"
+  s.version     = "0.1.1"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Linus Oleander"]
   s.email       = ["linus@oleander.nu"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Linus Oleander
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 +01:00
+date: 2011-01-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency