myshows 0.1.1 → 0.2.0

data/Manifest

@@ -1,7 +1,6 @@
 Manifest
 README.rdoc
 Rakefile
-all-api.rb
 lib/myshows.rb
 lib/myshows/api.rb
 lib/myshows/episode.rb
@@ -9,5 +8,7 @@ lib/myshows/item.rb
 lib/myshows/profile.rb
 lib/myshows/search.rb
 lib/myshows/show.rb
+lib/myshows/title_matcher.rb
 myshows.gemspec
 spec/myshows_spec.rb
+spec/title_matcher_spec.rb

data/README.rdoc

@@ -11,6 +11,10 @@ And use
   profile = MyShows::Profile.new 'demo', 'fe01ce2a7fbac8fafaed7c982a04e229'
   profile.shows   # => all user shows
 
+  # you can find show by title among user shows (smart search)
+  profile.show 'big bang theory' # => show "The Big Bang Theory"
+  profile.show 'TBBT'            # => show "The Big Bang Theory"
+
   search = MyShows::Search.new
   tbbt = search.show("The Big Bang Theory").first
   tbbt.title      # => "The Big Bang Theory"
@@ -18,6 +22,10 @@ And use
   # and many other fields provided by API
 
   tbbt.episodes   # => [...] - all episodes
+
+  # you can find episode by title (smart search)
+  pilot = tbbt.episode "the pilot episode"
+  # or by season and episode number
   pilot = tbbt.episode 1, 1
   pilot.title     # => "Pilot"
   pilot.show      # => tbbt

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('myshows', '0.1.1') do |p|
+Echoe.new('myshows', '0.2.0') do |p|
   p.summary        = "MyShows API"
   p.description    = "Object-oriented wrapper over API of http://myshows.ru"
   p.url            = "http://github.com/cypok/myshows"

data/lib/myshows/profile.rb

@@ -1,4 +1,5 @@
 require 'myshows/api'
+require 'myshows/title_matcher'
 
 module MyShows
   # Profile initialization is needed to gain access
@@ -18,5 +19,24 @@ module MyShows
     def shows
       @api.user_shows
     end
+
+    # Smart search of one of user shows by title
+    def show(title)
+      found = shows.values_at *matcher.match(title)
+      case found.count
+      when 0
+        raise MyShows::Error.new "show with title \"#{title}\" was not found"
+      when 1
+        found.first
+      else
+        raise MyShows::Error.new "ambiguous title \"#{title}\" corresponds to shows #{found.map {|s| %Q["#{s}"]} * ', '}"
+      end
+    end
+
+    protected
+
+    def matcher
+      @matcher ||= MyShows::TitleMatcher.new shows.map(&:title)
+    end
   end
 end

data/lib/myshows/show.rb

@@ -1,4 +1,5 @@
 require 'myshows/item'
+require 'myshows/title_matcher'
 
 module MyShows
   # Provides such methods:
@@ -36,9 +37,39 @@ module MyShows
       @api.show_episodes self
     end
 
-    # Returns episode by season and episode number
-    def episode(season_number, episode_number)
-      episodes.detect {|e| e.season_number == season_number && e.episode_number == episode_number }
+    # Returns episode by title (smart search) or by season and episode number
+    def episode(*args)
+      if args.first.is_a? String
+        episode_by_title *args
+      else
+        episode_by_numbers *args
+      end
+    end
+
+    protected
+
+    def episode_by_title(title)
+      found = episodes.values_at *matcher.match(title)
+      case found.count
+      when 0
+        raise MyShows::Error.new "episode with title \"#{title}\" was not found in show #{self}"
+      when 1
+        found.first
+      else
+        raise MyShows::Error.new "ambiguous title \"#{title}\" corresponds to episodes #{found.map {|s| %Q["#{s}"]} * ', '}"
+      end
+    end
+
+    def matcher
+      @matcher ||= MyShows::TitleMatcher.new episodes.map(&:title)
+    end
+
+    def episode_by_numbers(season_number, episode_number)
+      episodes.detect {|e| e.season_number == season_number && e.episode_number == episode_number }.tap do |e|
+        if e.nil?
+          raise MyShows::Error.new "episode with number #{season_number}x#{episode_number} was not found in show #{self}"
+        end
+      end
     end
   end
 end

data/lib/myshows/title_matcher.rb

@@ -0,0 +1,67 @@
+module MyShows
+  class TitleMatcher
+    # You could extend this list
+    MATCHING_PROCS = [
+      # simple
+      proc {|src, title| src == title },
+
+      # flash forward => FlashForward
+      # lietome => Lie to Me
+      proc {|src, title| src.gsub(' ', '') == title.gsub(' ', '') },
+
+      # tbbt => The Big Bang Theory
+      proc {|src, title| src == title.split.map{|w| w[0,1]} * '' },
+
+      # avatar => Avatar: The Last Airbender
+      proc {|src, title| title.split.include? src },
+
+      # house m d => House
+      proc {|src, title| src.split.include? title },
+    ]
+
+    def initialize(titles)
+      @titles = titles.map {|s| strip(s)}
+      @titles_wo_articles = @titles.map {|t| wo_articles(t) }
+    end
+
+    # Tries to find title closest to src,
+    # returns list of indexes of titles
+    def match(src)
+      matched = []
+
+      src = strip(src)
+
+
+      MATCHING_PROCS.each do |matcher|
+        @titles.each_with_index do |title, i|
+          matched << i if matcher.call(src, title)
+        end
+        return matched unless matched.empty?
+      end
+
+      src_wo_articles = wo_articles(src)
+      MATCHING_PROCS.each do |matcher|
+        @titles_wo_articles.each_with_index do |title_wo_articles, i|
+          matched << i if matcher.call(src_wo_articles, title_wo_articles)
+        end
+        return matched unless matched.empty?
+      end
+
+      []
+    end
+
+    private
+
+    def strip(s)
+      s.clone.downcase.
+              gsub(/\(\d{4}\)/, '').        # to clean "V (2009)"
+              gsub(/\([A-Za-z]{2}\)/, '').  # to clean "Bless This House (US)"
+              gsub(/[^A-Za-z0-9]/, ' ').    # to clean "Star Wars: the Clone Wars"
+              gsub(/  +/, ' ').strip        # remove extra spaces
+    end
+
+    def wo_articles(str)
+      str.split.reject {|w| w =~ /^the|an?$/ } * ' '
+    end
+  end
+end

data/myshows.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{myshows}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Vladimir Parfinenko"]
   s.cert_chain = ["/Users/cypok/.gem/gem-public_cert.pem"]
-  s.date = %q{2011-01-26}
+  s.date = %q{2011-01-29}
   s.description = %q{Object-oriented wrapper over API of http://myshows.ru}
   s.email = %q{vladimir.parfinenko@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb", "myshows.gemspec", "spec/myshows_spec.rb"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb", "lib/myshows/title_matcher.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/myshows.rb", "lib/myshows/api.rb", "lib/myshows/episode.rb", "lib/myshows/item.rb", "lib/myshows/profile.rb", "lib/myshows/search.rb", "lib/myshows/show.rb", "lib/myshows/title_matcher.rb", "myshows.gemspec", "spec/myshows_spec.rb", "spec/title_matcher_spec.rb"]
   s.homepage = %q{http://github.com/cypok/myshows}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Myshows", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/spec/myshows_spec.rb

@@ -11,6 +11,24 @@ describe MyShows do
     it "should return user shows" do
       @profile.shows.map(&:title).should include TBBT
     end
+
+    describe "#show" do
+      it "should find user show by title" do
+        @profile.show('TBBT').title.should == TBBT
+      end
+
+      it "should raise exception if show was not found" do
+        lambda do
+          @profile.show('WTF?')
+        end.should raise_error MyShows::Error
+      end
+
+      it "should raise exception if title is ambiguous" do
+        lambda do
+          @profile.show('The')
+        end.should raise_error MyShows::Error
+      end
+    end
   end
 
   describe MyShows::Search do
@@ -42,10 +60,38 @@ describe MyShows do
       @show.episodes.should have_at_least(10).items
     end
 
-    it "should find episode by season and episode number" do
-      e = @show.episode(1, 2)
-      e.season_number.should == 1
-      e.episode_number.should == 2
+    describe "#episode" do
+
+      it "should find episode by season and episode number" do
+        e = @show.episode(1, 2)
+        e.season_number.should == 1
+        e.episode_number.should == 2
+      end
+
+      it "should find episode by title" do
+        e = @show.episode("pilot")
+        e.title.should == "Pilot"
+        e.season_number.should == 1
+        e.episode_number.should == 1
+      end
+
+      it "should raise exception if nothing was found" do
+        lambda do
+          @show.episode(99, 99)
+        end.should raise_error MyShows::Error
+      end
+
+      it "should raise exception if nothing was found" do
+        lambda do
+          @show.episode "Non existent episode"
+        end.should raise_error MyShows::Error
+      end
+
+      it "should raise exception if title is ambiguous" do
+        lambda do
+          @show.episode "The"
+        end.should raise_error MyShows::Error
+      end
     end
   end
 

data/spec/title_matcher_spec.rb

@@ -0,0 +1,83 @@
+require 'myshows'
+
+describe MyShows::TitleMatcher do
+  before :all do
+    @titles = <<-END
+V (2009)
+Star Wars: The Clone Wars (2008)
+Over There (US)
+South Park
+Lost
+How I Met Your Mother
+The IT Crowd
+Due South (1994)
+The Big Bang Theory
+Life on Mars (UK)
+Lie to Me
+Avatar: The Last Airbender
+FlashForward
+Desperate Housewifes
+    END
+    @titles = @titles.split "\n"
+
+    @matcher = MyShows::TitleMatcher.new @titles
+  end
+
+  it "should find nothing" do
+    match("Unknown series").should be_empty
+  end
+
+  it "should simply find" do
+    match("Lost").should == ["Lost"]
+  end
+
+  it "should ingore year of series start" do
+    match("V").should == ["V (2009)"]
+  end
+
+  it "should ingore country of series creation" do
+    match("Over There").should == ["Over There (US)"]
+  end
+
+  it "should ignore all but letters" do
+    match("Star Wars The Clone Wars").should == ["Star Wars: The Clone Wars (2008)"]
+  end
+
+  it "should find ambiguous titles" do
+    match("South").should == ["South Park", "Due South (1994)"]
+  end
+
+  it "should find separeted title" do
+    match("Flash Forward").should == ["FlashForward"]
+  end
+
+  it "should find joined title" do
+    match("lietome").should == ["Lie to Me"]
+  end
+
+  it "should find some part of title in src" do
+    match("Avatar").should == ["Avatar: The Last Airbender"]
+  end
+
+  it "should find abbreviated title" do
+    match("TBBT").should == ["The Big Bang Theory"]
+  end
+
+  it "should find title with extra article" do
+    match("Life on a Mars").should == ["Life on Mars (UK)"]
+  end
+
+  it "should find title without article" do
+    match("IT Crowd").should == ["The IT Crowd"]
+  end
+
+  it "should find title with wrong article" do
+    match("An IT Crowd").should == ["The IT Crowd"]
+  end
+
+  protected
+
+  def match(src)
+    @titles.values_at *@matcher.match(src)
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: myshows
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Vladimir Parfinenko
@@ -36,7 +36,7 @@ cert_chain:
   78F0qvtLjR0DAnN6uYs98PR+jHE+0ckLX3D9sw==
   -----END CERTIFICATE-----
 
-date: 2011-01-26 00:00:00 +06:00
+date: 2011-01-29 00:00:00 +06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -110,6 +110,7 @@ extra_rdoc_files:
 - lib/myshows/profile.rb
 - lib/myshows/search.rb
 - lib/myshows/show.rb
+- lib/myshows/title_matcher.rb
 files: 
 - Manifest
 - README.rdoc
@@ -121,8 +122,10 @@ files:
 - lib/myshows/profile.rb
 - lib/myshows/search.rb
 - lib/myshows/show.rb
+- lib/myshows/title_matcher.rb
 - myshows.gemspec
 - spec/myshows_spec.rb
+- spec/title_matcher_spec.rb
 has_rdoc: true
 homepage: http://github.com/cypok/myshows
 licenses: []