plex-ruby 1.3.0 → 1.3.1

data/CHANGELOG.md

@@ -44,3 +44,18 @@
 ## 1.2.0
 
 * `Plex::Client#play_media` now can take an Object that `responds_to(:key)`
+
+## 1.3.0
+
+* 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 
+  the lazy loading, but allows this gem to grow with Plex without having to update
+  the code everytime the API changes.
+
+## 1.3.1
+
+* Got rid of stdout garbage
+* Fixed `Show#season` not working
+* Added tests

data/README.md

@@ -1,6 +1,6 @@
-# Plex-Ruby [![Build Status](https://secure.travis-ci.org/ekosz/Plex-Ruby.png)](https://secure.travis-ci.org/ekosz/Plex-Ruby.png)
+# Plex-Ruby [![Build Status](https://secure.travis-ci.org/ekosz/Plex-Ruby.png)](https://secure.travis-ci.org/ekosz/Plex-Ruby)
 
-A handy gem for working with Plex within Ruby.  Tries to emulate and document
+A handy gem for working with [Plex Media Player](http://plexapp.com) within Ruby.  Tries to emulate and document
 all of the Plex APIs using simple ruby code.  I will try and keep it as
 up-to-date as possible, but pull requests are always welcomed.
 
@@ -36,23 +36,22 @@ server = Plex::Server.new(CONFIG[:host], CONFIG[:port])
 From here we can start doing cool things. Lets pause whats currently playing.
 
 ```ruby
-clients = server.clients
-client = # pick the media player you want
-client.pause # That was easy
+clients = server.clients  # list of all connected clients
+client =                  # pick the media player you want
+client.pause              # That was easy
 ````
 
 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
-bsg.seasons # array of its seasons
-episodes = bsg.seasons.last.episodes # Array the last seasons episodes
-episode = episodes[4] # 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.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!
 ```
 
 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,14 @@ module Plex
       ping player_url+"/application/sendVirtualKey?code=#{CGI::escape(code.to_s)}"
     end
 
-    def url
+    def url #:nodoc:
       server.url
     end
 
+    def inspect #:nodoc:
+      "#<Plex::Client: name=\"#{name}\" host=\"#{host}\" port=\"#{port}\">"
+    end
+
     private
 
     def player_url

data/lib/plex-ruby/episode.rb

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

data/lib/plex-ruby/library.rb

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

data/lib/plex-ruby/movie.rb

@@ -10,7 +10,7 @@ module Plex
       @key = key
     end
 
-    def url
+    def url #:nodoc:
       section.url
     end
 
@@ -24,6 +24,10 @@ module Plex
       end
     end
 
+    def inspect #:nodoc:
+      "#<Plex::Movie: key=\"#{key}\" title=\"#{title}\">"
+    end
+
     private
 
     def xml_doc

data/lib/plex-ruby/season.rb

@@ -39,11 +39,11 @@ module Plex
       episodes.select { |epi| epi.index.to_i == number.to_i }.first
     end
 
-    def url
+    def url #:nodoc:
       show.url
     end
 
-    def ==(other)
+    def ==(other) #:nodoc:
       if other.is_a? Plex::Season
         key == other.key
       else
@@ -51,6 +51,10 @@ module Plex
       end
     end
 
+    def inspect #:nodoc:
+      "#<Plex::Season: key=\"#{key}\" title=\"#{title}\" index=\"#{index}\" show=\"#{show.title}\">"
+    end
+
     private
 
     def base_doc
@@ -70,12 +74,16 @@ module Plex
     end
 
     def episodes_from_video(node)
-      node.search("Video").map { |m| Plex::Episode.new(self, m.attr('key')) }
+      node.search("Video").map { |m| plex_episode.new(self, m.attr('key')) }
     end
 
     def directory
       @directory ||= xml_doc.search("Directory").first
     end
 
+    def plex_episode
+      @plex_episode ||= Plex::Episode
+    end
+
   end
 end

data/lib/plex-ruby/section.rb

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

data/lib/plex-ruby/server.rb

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

data/lib/plex-ruby/show.rb

@@ -36,14 +36,14 @@ 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 == sea.to_i }.first
+      seasons.select { |sea| sea.index.to_i == number.to_i }.first
     end
 
-    def url
+    def url #:nodoc:
       section.url
     end
 
-    def ==(other)
+    def ==(other) #:nodoc:
       if other.is_a? Plex::Show
         key == other.key
       else
@@ -51,6 +51,10 @@ module Plex
       end
     end
 
+    def inspect #:nodoc:
+      "#<Plex::Show: key=\"#{key}\" title=\"#{title}\">"
+    end
+
     private
 
     def base_doc

data/lib/plex-ruby/version.rb

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

data/plex-ruby.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Eric Koslow"]
   s.email       = ["ekoslow@gmail.com"]
   s.homepage    = "https://github.com/ekosz/Plex-Ruby"
-  s.summary     = %q{Plex APIs in easy ruby code}
-  s.description = %q{Extracts the Plex API into easy to write ruby code}
+  s.summary     = %q{Plex Media Server APIs in easy ruby code}
+  s.description = %q{Extracts the Plex Media Server API into easy to write ruby code}
 
   s.rubyforge_project = "plex-ruby"
 

data/test/test_episode.rb

@@ -1,5 +1,12 @@
 require 'test_helper'
 
+class TestEpisode < Plex::Episode
+  def initialize(parent, key)
+    @xml_doc = FakeNode.new({Video: FakeNode.new(FAKE_VIDEO_NODE_HASH)})
+    super(parent, key)
+  end
+end
+
 describe Plex::Episode do
 
   before do

data/test/test_helper.rb

@@ -183,6 +183,7 @@ FAKE_VIDEO_NODE_HASH = {
   duration: '3400', 
   originally_available_at: '324124', 
   updated_at: '342214', 
+  index: '1',
   Media: FakeNode.new( FAKE_MEDIA_NODE_HASH ), 
   Genre: FakeNode.new( FAKE_GENRE_NODE_HASH ), 
   Writer: FakeNode.new( FAKE_WRITER_NODE_HASH ),

data/test/test_season.rb

@@ -28,6 +28,14 @@ describe Plex::Season do
     )
   end
 
+  it "should return a spesific show" do
+    @season.instance_variable_set(
+      "@children", FakeNode.new({Video: FakeNode.new(FAKE_VIDEO_NODE_HASH)})
+    )
+    @season.instance_variable_set( "@plex_episode", TestEpisode )
+    @season.episode(1).must_equal @season.episodes.first
+  end
+
   it "should remember its parent (show)" do
     @season.show.must_equal @show
   end

data/test/test_show.rb

@@ -30,6 +30,14 @@ describe Plex::Show do
     )
   end
 
+  it "should return a spesific season" do
+    @show.instance_variable_set(
+      "@children", FakeNode.new(FAKE_SEASON_NODE_HASH)
+    )
+    @show.instance_variable_set( "@plex_season", TestSeason )
+    @show.season(1).must_equal @show.seasons.first
+  end
+
   it "should remember its parent (section)" do
     @show.section.must_equal @section
   end

metadata

@@ -2,7 +2,7 @@
 name: plex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors: 
 - Eric Koslow
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-21 00:00:00 -05:00
+date: 2012-01-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,7 +57,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id004
-description: Extracts the Plex API into easy to write ruby code
+description: Extracts the Plex Media Server API into easy to write ruby code
 email: 
 - ekoslow@gmail.com
 executables: []
@@ -132,7 +132,7 @@ rubyforge_project: plex-ruby
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Plex APIs in easy ruby code
+summary: Plex Media Server APIs in easy ruby code
 test_files: 
 - test/test_client.rb
 - test/test_episode.rb