plex-ruby 1.3.1 → 1.4.0

data/CHANGELOG.md

@@ -22,7 +22,7 @@
 
 ## 0.3.1
 
-* Fix `gem install plex-ruby`, require `open-uri` as a runtime dependecy 
+* Fix `gem install plex-ruby`, require `open-uri` as a runtime dependency 
   wasn't a good idea
 
 ## 1.0.0
@@ -50,12 +50,27 @@
 * snake_case() -> underscore()
 * Added Plex class method `camalize`
 * Added singular season and episode methods
-* Attribute methods are now dynamicly created in the initializer.  This gets ride of 
+* Attribute methods are now dynamically created in the initializer.  This gets ride of 
   the lazy loading, but allows this gem to grow with Plex without having to update
-  the code everytime the API changes.
+  the code every time the API changes.
 
 ## 1.3.1
 
 * Got rid of stdout garbage
 * Fixed `Show#season` not working
 * Added tests
+
+## 1.4.0
+
+* Switched from Array#select().first to Array#detect for performance
+* Plex::Season helper methods
+    * #first_episode
+    * #last_episode
+* Plex::Show helper methods
+    * #first_season
+    * #last_season
+    * #special_season
+    * #first_episode
+    * #last_episode
+* Updated Readme to use new helper methods
+* Cleaned up docs by adding @private to internal public methods

data/README.md

@@ -26,7 +26,7 @@ lesser versions of Ruby.
 
 ## Usage
 
-Everything Stems from the Plex MediaServer. Create a server with the host and
+Everything Stems from the Plex Media Server. Create a server with the host and
 port number.
 
 ```ruby
@@ -45,13 +45,13 @@ Lets search the libary.
 
 ```ruby
 sections = server.library.sections
-section =                                                 # Pick the section you want I.E. TV, Movies, Home Videos
-shows = section.all                                       # Returns a list of shows/movies
-bsg = shows.select { |s| s.title =~ /Battlestar/ }.first  # Pick a great show
-season = bsg.seasons.last                                 # Pick the last season
-episode = season.episode(5)                               # The fifth episode in the season
-puts "#{episode.title} - #{episode.summary}"              # Looks good
-client.play_media(episode)                                # Play it!
+section =                                           # Pick the section you want I.E. TV, Movies, Home Videos
+shows = section.all                                 # Returns a list of shows/movies
+bsg = shows.detect { |s| s.title =~ /Battlestar/ }  # Pick a great show
+season = bsg.last_season                            # Pick the last season
+episode = season.episode(5)                         # The fifth episode in the season
+puts "#{episode.title} - #{episode.summary}"        # Looks good
+client.play_media(episode)                          # Play it!
 ```
 
 For a full list of commands check out the [documentation](http://rubydoc.info/github/ekosz/Plex-Ruby/master/frames).

data/lib/plex-ruby/client.rb

@@ -120,10 +120,12 @@ module Plex
       ping player_url+"/application/sendVirtualKey?code=#{CGI::escape(code.to_s)}"
     end
 
+    # @private
     def url #:nodoc:
       server.url
     end
 
+    # @private
     def inspect #:nodoc:
       "#<Plex::Client: name=\"#{name}\" host=\"#{host}\" port=\"#{port}\">"
     end

data/lib/plex-ruby/episode.rb

@@ -20,10 +20,12 @@ module Plex
       end
     end
 
+    # @private
     def url #:nodoc:
       season.url
     end
 
+    # @private
     def ==(other) #:nodoc:
       if other.is_a? Plex::Episode
         key == other.key
@@ -32,6 +34,7 @@ module Plex
       end
     end
 
+    # @private
     def inspect #:nodoc:
       "#<Plex::Episode key=\"#{key}\" title=\"#{title}\" index=\"#{index}\" season=\"#{season.index}\" show=\"#{season.show.title}\">"
     end

data/lib/plex-ruby/library.rb

@@ -33,14 +33,17 @@ module Plex
       @sections = search_sections(xml_doc!)
     end
 
+    # @private
     def key #:nodoc:
       "/library/sections"
     end
 
+    # @private
     def url #:nodoc:
       server.url
     end
 
+    # @private
     def ==(other) #:nodoc:
       if other.is_a? Library
         server == other.server
@@ -49,6 +52,7 @@ module Plex
       end
     end
 
+    # @private
     def inspect #:nodoc:
       "#<Plex::Libary: server=#{server.inspect}>"
     end

data/lib/plex-ruby/movie.rb

@@ -10,10 +10,6 @@ module Plex
       @key = key
     end
 
-    def url #:nodoc:
-      section.url
-    end
-
     # Delegates all method calls to the video object that represents this
     # movie, if that video object responds to the method.
     def method_missing(method, *args, &block)
@@ -24,6 +20,12 @@ module Plex
       end
     end
 
+    # @private
+    def url #:nodoc:
+      section.url
+    end
+
+    # @private
     def inspect #:nodoc:
       "#<Plex::Movie: key=\"#{key}\" title=\"#{title}\">"
     end

data/lib/plex-ruby/season.rb

@@ -36,13 +36,29 @@ module Plex
     # @param [Fixnum, String] episode index number
     # @return [Episode] episode with the index of number
     def episode(number)
-      episodes.select { |epi| epi.index.to_i == number.to_i }.first
+      episodes.detect { |epi| epi.index.to_i == number.to_i }
     end
 
+    # Selects the first episode of this season that is on the Plex Server
+    #
+    # @return [Episode] episode with the lowest index
+    def first_episode
+      episodes.inject { |a, b| a.index < b.index ? a : b }
+    end
+
+    # Selects the last episode  of this season that is on the Plex Server
+    #
+    # @return [Episode] episode with the highest index
+    def last_episode
+      episodes.inject { |a, b| a.index > b.index ? a : b }
+    end
+
+    # @private
     def url #:nodoc:
       show.url
     end
 
+    # @private
     def ==(other) #:nodoc:
       if other.is_a? Plex::Season
         key == other.key
@@ -51,6 +67,7 @@ module Plex
       end
     end
 
+    # @private
     def inspect #:nodoc:
       "#<Plex::Season: key=\"#{key}\" title=\"#{title}\" index=\"#{index}\" show=\"#{show.title}\">"
     end

data/lib/plex-ruby/section.rb

@@ -76,14 +76,17 @@ module Plex
       )
     }
 
+    # @private
     def key #:nodoc:
       "/library/sections/#{@key}"
     end
     
+    # @private
     def url #:nodoc:
       library.url
     end
 
+    # @private
     def ==(other) #:nodoc:
       if other.is_a? Plex::Section
         key == other.key
@@ -92,6 +95,7 @@ module Plex
       end
     end
 
+    # @private
     def inspect #:nodoc:
       "#<Plex::Section: key=\"#{key}\" type=\"#{type}\" title=\"#{title}\">"
     end

data/lib/plex-ruby/server.rb

@@ -27,10 +27,12 @@ module Plex
       @clients = search_clients clients_doc!
     end
 
+    # @private
     def url #:nodoc:
       "http://#{host}:#{port}"
     end
 
+    # @private
     def inspect #:nodoc:
       "#<Plex::Server: host=#{host} port=#{port}>"
     end

data/lib/plex-ruby/show.rb

@@ -36,13 +36,55 @@ module Plex
     # @param [Fixnum, String] season index number
     # @return [Season] season with the index of number
     def season(number)
-      seasons.select { |sea| sea.index.to_i == number.to_i }.first
+      seasons.detect { |sea| sea.index.to_i == number.to_i }
     end
 
+    # Helper method for selecting the special Season of this show
+    # Season 0 is where Plex stores episodes that are not part of a 
+    # regular season. i.e. Christmas Specials
+    #
+    # @return [Season] season with index of 0
+    def special_season
+      season(0)
+    end
+
+    # Selects the first season of this show that is on the Plex Server
+    # Does not select season 0
+    #
+    # @return [Season] season with the lowest index (but not 0)
+    def first_season
+      seasons.inject { |a, b| a.index < b.index && a.index > 0 ? a : b }
+    end
+
+    # Selects the last season of this show that is on the Plex Server
+    #
+    # @return [Season] season with the highest index
+    def last_season
+      seasons.inject { |a, b| a.index > b.index ? a : b }
+    end
+
+    # Selects the first episode of this show that is on the Plex Server
+    #
+    # @return [Episode] episode with the lowest index of the season of the
+    #   lowest index
+    def first_episode
+      first_season.first_episode
+    end
+
+    # Selects the last episode of this show that is on the Plex Server
+    #
+    # @return [Episode] episode with the highest index of the season of the
+    #   highest index
+    def last_episode
+      last_season.last_episode
+    end
+
+    # @private
     def url #:nodoc:
       section.url
     end
 
+    # @private
     def ==(other) #:nodoc:
       if other.is_a? Plex::Show
         key == other.key
@@ -51,6 +93,7 @@ module Plex
       end
     end
 
+    # @private
     def inspect #:nodoc:
       "#<Plex::Show: key=\"#{key}\" title=\"#{title}\">"
     end

data/lib/plex-ruby/version.rb

@@ -1,3 +1,3 @@
 module Plex
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: plex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors: 
 - Eric Koslow
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-02 00:00:00 -05:00
+date: 2012-01-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency