plex-ruby 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -14,3 +14,8 @@
 * Added bang methods that clears caches
 * Fix naming of 'libary' to 'library'
 * Moved static content into Constants (Wow!\s)
+
+## 0.3.0
+
+* Now allows for multiple servers
+* Fix a misspelling of 'library' that broke the gem (Sorry!)

data/README.md

@@ -54,7 +54,7 @@ puts "#{episodes.first.title} - #{episodes.first.summary}" # Looks good
 client.play_media(episodes.first.key) # Play it!
 ```
 
-For a full list of commands check out the documentation.
+For a full list of commands check out the [documentation](http://rubydoc.info/github/ekosz/Plex-Ruby/master/frames).
 
 ## Development
 

data/lib/plex-ruby.rb

@@ -5,7 +5,7 @@ require 'cgi'
 module Plex
 
   # Converts camel case names that are commonly found in the Plex APIs into
-  # ruby friendly names.  I.E. playMedia -> play_media
+  # ruby friendly names.  I.E. <tt>playMedia</tt> -> <tt>play_media</tt>
   #
   # @param [String] camel case name to be converted
   # @return [String] snake case form
@@ -17,18 +17,6 @@ module Plex
     downcase
   end
 
-  # The base url of the Plex Media Server, I.E. 'http://localhost:32400'
-  # !WARNING! This method will most likely be replaced in future versions
-  #
-  # @return [String] bases url of the Plex Media Server
-  def self.url
-    @@base_url
-  end
-
-  def self.url=(val)
-    @@base_url = val
-  end
-
 end
 
 require 'plex-ruby/parser'

data/lib/plex-ruby/client.rb

@@ -7,9 +7,13 @@ module Plex
     PLAYBACK_METHODS = %w(play pause stop rewind fastForward stepForward 
                           bigStepForward stepBack bigStepBack skipNext skipPrevious)
 
-    attr_reader :name, :host, :address, :port, :machine_identifier, :version
+    attr_reader :server, :name, :host, :address, :port, :machine_identifier, :version
 
-    def initialize(node)
+
+    # @param [Server] server this client belongs to
+    # @param [Nokogiri::XML::Element] nokogiri element to build from
+    def initialize(server, node)
+      @server = server
       @name = node.attr('name')
       @host = node.attr('host')
       @address = node.attr('address')
@@ -59,7 +63,7 @@ module Plex
     #   the console for the error message
     def play_media(key, user_agent = nil, http_cookies = nil, view_offset = nil)
       url = player_url+'/application/playMedia?'
-      url += "path=#{CGI::escape(Plex.url+key)}"
+      url += "path=#{CGI::escape(server.url+key)}"
       url += "&key=#{CGI::escape(key)}"
       url += "&userAgent=#{user_agent}" if user_agent
       url += "&httpCookies=#{http_cookies}" if http_cookies
@@ -111,10 +115,14 @@ module Plex
       ping player_url+"/application/sendVirtualKey?code=#{CGI::escape(code.to_s)}"
     end
 
+    def url
+      server.url
+    end
+
     private
 
     def player_url
-      Plex.url+"/system/players/#{name}"
+      url+"/system/players/#{name}"
     end
 
     def ping(url)

data/lib/plex-ruby/episode.rb

@@ -1,9 +1,12 @@
 module Plex
   class Episode
 
-    attr_reader :key
+    attr_reader :season, :key
 
-    def initialize(key)
+    # @param [Season] season this episode belongs to
+    # @param [String] key that we can use to later grab this Episode
+    def initialize(season, key)
+      @season = season
       @key = key
     end
     
@@ -17,10 +20,14 @@ module Plex
       end
     end
 
+    def url
+      season.url
+    end
+
     private
 
     def xml_doc
-      @xml_doc ||= Nokogiri::XML( open(Plex.url+key) )
+      @xml_doc ||= Nokogiri::XML( open(url+key) )
     end
 
     def video

data/lib/plex-ruby/library.rb

@@ -1,6 +1,13 @@
 module Plex
   class Library
 
+    attr_reader :server
+
+    # @param [Server] server this libary belongs to
+    def initialize(server)
+      @server = server
+    end
+
     # Grab a specific section
     #
     # @param [String, Fixnum] key of the section we want
@@ -30,11 +37,15 @@ module Plex
       "/library/sections"
     end
 
+    def url
+      server.url
+    end
+
     private
 
     def search_sections(doc, key = nil)
       term = key ? "Directory[@key='#{key}']" : 'Directory'
-      doc.search(term).map { |m| Plex::Section.new(m.attributes) }
+      doc.search(term).map { |m| Plex::Section.new(self, m) }
     end
 
     def xml_doc
@@ -46,7 +57,7 @@ module Plex
     end
 
     def base_doc
-      Nokogiri::XML( open(Plex.url+key) )
+      Nokogiri::XML( open(url+key) )
     end
 
 

data/lib/plex-ruby/media.rb

@@ -4,6 +4,8 @@ module Plex
       :audio_codec, :video_codec, :video_resolution, :container, :video_frame_rate,
       :parts
 
+    # @param [Nokogiri::XML::Element] nokogiri element that represents this
+    #   Media
     def initialize(node)
       @id               = node.attr('id')
       @durration        = node.attr('durration')

data/lib/plex-ruby/movie.rb

@@ -1,12 +1,19 @@
 module Plex
   class Movie
 
-    attr_reader :key
+    attr_reader :section, :key
 
-    def initialize(key)
+    # @param [Section] section this movie belongs in
+    # @param [String] key to later referance this Movie
+    def initialize(section, key)
+      @section = section
       @key = key
     end
 
+    def url
+      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)
@@ -20,7 +27,7 @@ module Plex
     private
 
     def xml_doc
-      @xml_doc ||= Nokogiri::XML( open(Plex.url+key) )
+      @xml_doc ||= Nokogiri::XML( open(url+key) )
     end
 
     def video

data/lib/plex-ruby/parser.rb

@@ -1,9 +1,12 @@
 module Plex
   class Parser
 
-    attr_reader :node
+    attr_reader :parent, :node
 
-    def initialize(node)
+    # @param object representing the parent of what we're trying to parse
+    # @param [Nokogiri::XML::Element] nokogiri node to parse
+    def initialize(parent, node)
+      @parent = parent
       @node = node
     end
 
@@ -17,7 +20,7 @@ module Plex
     def parse
       case node.name
       when 'document'
-        Plex::Parser.new(node.root).parse
+        Plex::Parser.new(parent, node.root).parse
       when 'MediaContainer'
         parse_media_container
       when 'Video'
@@ -34,7 +37,7 @@ module Plex
 
     def parse_media_container
       return nil if node.attr('size').to_i == 0
-      node.children.map {|m| Plex::Parser.new(m).parse }.compact
+      node.children.map {|m| Plex::Parser.new(parent, m).parse }.compact
     end
 
     def parse_video
@@ -49,17 +52,17 @@ module Plex
     end
 
     def parse_movie
-      Plex::Movie.new( node.attr('key') )
+      Plex::Movie.new( parent, node.attr('key') )
     end
 
     def parse_episode
-      Plex::Episode.new( node.attr('key') )
+      Plex::Episode.new( parent, node.attr('key') )
     end
 
     def parse_directory
       case node.attr('type')
       when 'show'
-        Plex::Show.new( node.attr('key')[0..-10] ) # Remove /children
+        Plex::Show.new( parent, node.attr('key')[0..-10] ) # Remove /children
       else
         raise "Unsupported Directory type #{node.attr('type')}"
       end

data/lib/plex-ruby/part.rb

@@ -3,6 +3,8 @@ module Plex
 
     attr_reader :id, :key, :duration, :file, :size, :streams
 
+    # @param [Nokogiri::XML::Element] nokogiri element that represents this
+    #   part
     def initialize(node)
       @id       = node.attr('id')
       @key      = node.attr('key')

data/lib/plex-ruby/season.rb

@@ -5,9 +5,12 @@ module Plex
     ATTRIBUTES = %w(ratingKey guid type title summary index thumb leafCount 
                     viewedLeafCount addedAt updatedAt) 
 
-    attr_reader :key
+    attr_reader :show, :key
 
-    def initialize(key)
+    # @param [Show] show this Season belongs to
+    # @param [String] key to later grab this Season from
+    def initialize(show, key)
+      @show = show
       @key = key
     end
 
@@ -36,14 +39,18 @@ module Plex
       @episodes = episodes_from_video(children!)
     end
 
+    def url
+      show.url
+    end
+
     private
 
     def base_doc
-      Nokogiri::XML( open(Plex.url+key) )
+      Nokogiri::XML( open(url+key) )
     end
 
     def base_children_doc
-      Nokogiri::XML( open(Plex.url+key+'/children') )
+      Nokogiri::XML( open(url+key+'/children') )
     end
 
     def xml_doc
@@ -63,7 +70,7 @@ module Plex
     end
 
     def episodes_from_video(node)
-      node.search("Video").map { |m| Plex::Episode.new(m.attr('key')) }
+      node.search("Video").map { |m| Plex::Episode.new(self, m.attr('key')) }
     end
 
     def directory

data/lib/plex-ruby/section.rb

@@ -3,19 +3,23 @@ module Plex
 
     GROUPS = %w(all unwatched newest recentlyAdded recentlyViewed onDeck)
 
-    attr_reader :refreshing, :type, :title, :art, :agent, :scanner, :language, 
-      :updated_at
-
-    def initialize(options)
-      @refreshing = options['refreshing'].value
-      @key        = options['key'].value
-      @type       = options['type'].value
-      @title      = options['title'].value
-      @art        = options['art'].value
-      @agent      = options['agent'].value
-      @scanner    = options['scanner'].value
-      @language   = options['language'].value
-      @updated_at = options['updatedAt'].value
+    attr_reader :library, :refreshing, :type, :title, :art, :agent, :scanner, 
+      :language, :updated_at
+
+    # @param [Library] library this Section belongs to
+    # @param [Nokogiri::XML::Element] nokogiri element that represents this
+    #   Section
+    def initialize(library, node)
+      @library = library
+      @refreshing = node.attr('refreshing')
+      @key        = node.attr('key')
+      @type       = node.attr('type')
+      @title      = node.attr('title')
+      @art        = node.attr('art')
+      @agent      = node.attr('agent')
+      @scanner    = node.attr('scanner')
+      @language   = node.attr('language')
+      @updated_at = node.attr('updatedAt')
     end
 
     # NOT IMPLEMENTED
@@ -36,7 +40,7 @@ module Plex
     GROUPS.each { |method|
       class_eval %(
         def #{Plex.snake_case(method)}
-          Plex::Parser.new( Nokogiri::XML(open(Plex.url+key+'/#{method}')) ).parse
+          Plex::Parser.new( self, Nokogiri::XML(open(url+key+'/#{method}')) ).parse
         end
       )
     }
@@ -44,6 +48,10 @@ module Plex
     def key
       "/library/sections/#{@key}"
     end
+    
+    def url
+      library.url
+    end
 
   end
 end

data/lib/plex-ruby/server.rb

@@ -6,14 +6,13 @@ module Plex
     def initialize(host, port)
       @host = host
       @port = port
-      Plex.url = "http://#{host}:#{port}"
     end
 
     # The library of this server
     #
     # @return [Library] this Servers library
     def library
-      @library ||= Plex::Libary.new
+      @library ||= Plex::Library.new(self)
     end
 
     # The Plex clients that are connected to this Server
@@ -28,10 +27,14 @@ module Plex
       @clients = search_clients clients_doc!
     end
 
+    def url
+      "http://#{host}:#{port}"
+    end
+
     private
 
     def clients_base
-      Nokogiri::XML( open(Plex.url+'/clients') )
+      Nokogiri::XML( open(url+'/clients') )
     end
 
     def clients_doc
@@ -43,7 +46,7 @@ module Plex
     end
 
     def search_clients(node)
-      node.search('Server').map { |m| Plex::Client.new(m) }
+      node.search('Server').map { |m| Plex::Client.new(self, m) }
     end
 
   end

data/lib/plex-ruby/show.rb

@@ -6,9 +6,12 @@ module Plex
                     art banner theme duration originallyAvailableAt leafCount 
                     viewedLeafCount addedAt updatedAt)
 
-    attr_reader :key
+    attr_reader :section, :key
 
-    def initialize(key)
+    # @param [Section] section this show belongs to
+    # @param [String] key to use to later grab this Show
+    def initialize(section, key)
+      @section = section
       @key = key
     end
 
@@ -33,14 +36,18 @@ module Plex
       @seasons = search_children children!
     end
 
+    def url
+      section.url
+    end
+
     private
 
     def base_doc
-      Nokogiri::XML( open(Plex.url+key) )
+      Nokogiri::XML( open(url+key) )
     end
 
     def children_base
-      Nokogiri::XML( open(Plex.url+key+'/children') )
+      Nokogiri::XML( open(url+key+'/children') )
     end
 
     def xml_doc
@@ -69,7 +76,7 @@ module Plex
 
     def search_children(node)
       node.search('Directory').map do |season|
-        Plex::Season.new(season.attr('key')[0..-10]) # Remove /children
+        Plex::Season.new(self, season.attr('key')[0..-10]) # Remove /children
       end
     end
 

data/lib/plex-ruby/stream.rb

@@ -3,6 +3,8 @@ module Plex
 
     attr_reader :id, :stream_type, :codec, :index, :language, :language_code
 
+    # @param [Nokogiri::XML::Element] nokogiri element that represents this
+    #   Stream
     def initialize(node)
       @id             = node.attr('id')
       @stream_type    = node.attr('stream_type')

data/lib/plex-ruby/version.rb

@@ -1,3 +1,3 @@
 module Plex
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/plex-ruby/video.rb

@@ -6,6 +6,8 @@ module Plex
       :duration, :originally_available_at, :updated_at, :media, :genres, :writers,
       :directors, :roles
 
+    # @param [Nokogiri::XML::Element] nokogiri element that represents this
+    #   Video
     def initialize(node)
       @rating_key               = node.attr('ratingKey')
       @key                      = node.attr('key')

metadata

@@ -2,7 +2,7 @@
 name: plex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Eric Koslow