plex-ruby 1.0.0 → 1.1.0

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -1,4 +1,4 @@
-# Plex-Ruby
+# Plex-Ruby [![Build Status](https://secure.travis-ci.org/ekosz/Plex-Ruby.png)](https://secure.travis-ci.org/ekosz/Plex-Ruby.png)
 
 A handy gem for working with Plex within Ruby.  Tries to emulate and document
 all of the Plex APIs using simple ruby code.  I will try and keep it as

data/lib/plex-ruby/client.rb

@@ -7,19 +7,19 @@ module Plex
     PLAYBACK_METHODS = %w(play pause stop rewind fastForward stepForward 
                           bigStepForward stepBack bigStepBack skipNext skipPrevious)
 
-    attr_reader :server, :name, :host, :address, :port, :machine_identifier, :version
+    ATTRIBUTES = %w(name host address port machineIdentifier version)
+
+    attr_reader *ATTRIBUTES.map {|m| Plex.snake_case(m) }
+    attr_reader :server
 
 
     # @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')
-      @port = node.attr('port')
-      @machine_identifier = node.attr('machineIdentifier')
-      @version = node.attr('version')
+      ATTRIBUTES.each { |e|
+        instance_variable_set("@#{Plex.snake_case(e)}", node.attr(e))
+      }
     end
 
     # Navigation methods

data/lib/plex-ruby/media.rb

@@ -1,22 +1,18 @@
 module Plex
   class Media
-    attr_reader :id, :durration, :bitrate, :aspect_ratio, :audio_channels,
-      :audio_codec, :video_codec, :video_resolution, :container, :video_frame_rate,
-      :parts
+
+    ATTRIBUTES = %w(id durration bitrate aspectRatio audioChannels
+                    audioCodec videoCodec videoResolution container videoFrameRate)
+
+    attr_reader *ATTRIBUTES.map {|m| Plex.snake_case(m) }
+    attr_reader :parts
 
     # @param [Nokogiri::XML::Element] nokogiri element that represents this
     #   Media
     def initialize(node)
-      @id               = node.attr('id')
-      @durration        = node.attr('durration')
-      @bitrate          = node.attr('bitrate')
-      @aspect_ratio     = node.attr('aspectRatio')
-      @audio_channels   = node.attr('audioChannels')
-      @audio_codec      = node.attr('audioCodec')
-      @video_codec      = node.attr('videoCodec')
-      @video_resolution = node.attr('videoResolution')
-      @container        = node.attr('container')
-      @video_frame_rate = node.attr('videoFrameRate')
+      ATTRIBUTES.each { |e|
+        instance_variable_set("@#{Plex.snake_case(e)}", node.attr(e))
+      }
 
       @parts = node.search("Part").map { |m| Plex::Part.new(m) }
     end

data/lib/plex-ruby/part.rb

@@ -1,16 +1,17 @@
 module Plex
   class Part
 
-    attr_reader :id, :key, :duration, :file, :size, :streams
+    ATTRIBUTES = %w(id key duration file size)
+
+    attr_reader *ATTRIBUTES.map {|m| Plex.snake_case(m) }
+    attr_reader :streams
 
     # @param [Nokogiri::XML::Element] nokogiri element that represents this
     #   part
     def initialize(node)
-      @id       = node.attr('id')
-      @key      = node.attr('key')
-      @duration = node.attr('duration')
-      @file     = node.attr('file')
-      @size     = node.attr('size')
+      ATTRIBUTES.each { |e|
+        instance_variable_set("@#{Plex.snake_case(e)}", node.attr(e))
+      }
 
       @streams  = node.search('Stream').map { |m| Plex::Stream.new(m) }
     end

data/lib/plex-ruby/section.rb

@@ -3,23 +3,21 @@ module Plex
 
     GROUPS = %w(all unwatched newest recentlyAdded recentlyViewed onDeck)
 
-    attr_reader :library, :refreshing, :key, :type, :title, :art, :agent, :scanner, 
-      :language, :updated_at
+    ATTRIBUTES = %w(refreshing key type title art agent scanner language updatedAt)
+
+    CATEGORIES = %w(collection firstCharacter genre year contentRating folder)
+
+    attr_reader *ATTRIBUTES.map {|m| Plex.snake_case(m) }
+    attr_reader :library
 
     # @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')
+      ATTRIBUTES.each { |e|
+        instance_variable_set("@#{Plex.snake_case(e)}", node.attr(e))
+      }
     end
 
     # NOT IMPLEMENTED
@@ -45,6 +43,39 @@ module Plex
       )
     }
 
+    # Find TV Shows / Episodes by categories
+    #
+    # Format:
+    #    #{category}s        - Grab the keys => title in that category
+    #    #{category}s!       - cache busing version of #{category}s
+    #    by_#{category}(key) - all shows / movies by that key
+    #
+    # Example:
+    #     
+    #     library.section(2).by_year(2008) # List of TV Shows from 2008
+    #     library.section(1).by_first_character("H") # movies starting with 'H'
+    #     library.section(2).genres # Array of Hashes explaining all of the genres
+    #
+    # collection      - I'm not sure
+    # first_character - the first letter of the title of the video
+    # genre           - self explanatory
+    # year            - year first shown
+    # content_rating  - TV-14, TV-MA, etc
+    # folder          - where the video is stored
+    CATEGORIES.each { |method|
+      class_eval %(
+        def #{Plex.snake_case(method)}s
+          @#{Plex.snake_case(method)}s ||= grab_keys('#{method})'
+        end
+        def #{Plex.snake_case(method)}s!
+          @#{Plex.snake_case(method)}s = grab_keys('#{method})'
+        end
+        def by_#{Plex.snake_case(method)}(val)
+          Plex::Parser.new( self, Nokogiri::XML(open(url+key+"/#{method}/\#{val}")) ).parse
+        end
+      )
+    }
+
     def key
       "/library/sections/#{@key}"
     end
@@ -61,5 +92,17 @@ module Plex
       end
     end
 
+    private
+
+    def grab_keys(action)
+      Nokogiri::XML(open(url+key+"/#{action}")).search('Directory').map do |node| 
+        {
+          key: node.attr('key'),
+          title: node.attr('title')
+        }
+      end
+    end
+
+
   end
 end

data/lib/plex-ruby/stream.rb

@@ -1,17 +1,16 @@
 module Plex
   class Stream
 
-    attr_reader :id, :stream_type, :codec, :index, :language, :language_code
+    ATTRIBUTES = %w(id streamType codec index language languageCode)
+
+    attr_reader *ATTRIBUTES.map {|m| Plex.snake_case(m) }
 
     # @param [Nokogiri::XML::Element] nokogiri element that represents this
     #   Stream
     def initialize(node)
-      @id             = node.attr('id')
-      @stream_type    = node.attr('stream_type')
-      @codec          = node.attr('codec')
-      @index          = node.attr('index')
-      @language       = node.attr('language')
-      @language_code  = node.attr('language_code')
+      ATTRIBUTES.each { |e|
+        instance_variable_set("@#{Plex.snake_case(e)}", node.attr(e))
+      }
     end
 
     def ==(other)

data/lib/plex-ruby/version.rb

@@ -1,3 +1,3 @@
 module Plex
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/plex-ruby/video.rb

@@ -1,31 +1,19 @@
 module Plex
   class Video
-    
-    attr_reader :rating_key, :key, :studio, :type, :title, :title_sort, 
-      :content_rating, :summary, :rating, :view_count, :year, :tagline, :thumb, :art, 
-      :duration, :originally_available_at, :updated_at, :media, :genres, :writers,
-      :directors, :roles
+
+    ATTRIBUTES = %w(ratingKey key studio type title titleSort contentRating summary 
+                    rating viewCount year tagline thumb art duration 
+                    originallyAvailableAt updatedAt)
+      
+    attr_reader *ATTRIBUTES.map {|m| Plex.snake_case(m) }
+    attr_reader :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')
-      @studio                   = node.attr('studio')
-      @type                     = node.attr('type')
-      @title                    = node.attr('title')
-      @title_sort               = node.attr('titleSort')
-      @content_rating           = node.attr('contentRating')
-      @summary                  = node.attr('summary')
-      @rating                   = node.attr('rating')
-      @view_count               = node.attr('viewCount')
-      @year                     = node.attr('year')
-      @tagline                  = node.attr('tagline')
-      @thumb                    = node.attr('thumb')
-      @art                      = node.attr('art')
-      @duration                 = node.attr('duration')
-      @originally_available_at  = node.attr('originallyAvailableAt')
-      @updated_at               = node.attr('updatedAt')
+      ATTRIBUTES.each { |e|
+        instance_variable_set("@#{Plex.snake_case(e)}", node.attr(e))
+      }
 
       @media      = Plex::Media.new(node.search('Media').first)
       @genres     = node.search('Genre').map    { |m| Plex::Genre.new(m)    }

data/plex-ruby.gemspec

@@ -20,5 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'minitest'
+  s.add_development_dependency "rake"
+  s.add_development_dependency "fakeweb"
   s.add_runtime_dependency 'nokogiri'
 end

data/test/test_client.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+require 'fakeweb'
+
+describe Plex::Client do
+  before do
+    @server = FakeParent.new
+    @client = Plex::Client.new(@server, FakeNode.new(FAKE_CLIENT_NODE_HASH))
+    FakeWeb.register_uri(:get, %r|http://localhost:32400|, :body => "")
+  end
+
+  after do
+    FakeWeb.clean_registry
+  end
+
+  Plex::Client::NAV_METHODS.each { |method|
+    it "should properly communicate its ##{Plex.snake_case(method)} method" do
+      assert @client.send(Plex.snake_case(method).to_sym)
+      FakeWeb.last_request.path.must_equal "/system/players/#{@client.name}/navigation/#{method}"
+    end
+  }
+
+  Plex::Client::PLAYBACK_METHODS.each { |method|
+    it "should properly communicate its ##{Plex.snake_case(method)} method" do
+      assert @client.send(Plex.snake_case(method).to_sym)
+      FakeWeb.last_request.path.must_equal "/system/players/#{@client.name}/playback/#{method}"
+    end
+  }
+
+  it "should properly commnicate its  #play_file method" do
+    assert @client.play_file
+    FakeWeb.last_request.path.must_equal "/system/players/#{@client.name}/application/playFile"
+  end
+
+  it "should properly commnicate its  #play_media method" do
+    key = '/metadata/10'
+    assert @client.play_media(key)
+    FakeWeb.last_request.path.must_equal(
+      "/system/players/#{@client.name}/application/playMedia?path=#{CGI::escape(@client.url+key)}&key=#{CGI::escape(key)}"
+    )
+  end
+
+  it "should properly commnicate its  #screenshot method" do
+    assert @client.screenshot(100, 100, 75)
+    FakeWeb.last_request.path.must_equal(
+      "/system/players/#{@client.name}/application/screenshot?width=100&height=100&quality=75"
+    )
+  end
+
+  it "should properly commnicate its  #send_string method" do
+    assert @client.send_string(35)
+    FakeWeb.last_request.path.must_equal(
+      "/system/players/#{@client.name}/application/sendString?text=35"
+    )
+  end
+
+  it "should properly commnicate its  #send_key method" do
+    assert @client.send_key(70)
+    FakeWeb.last_request.path.must_equal(
+      "/system/players/#{@client.name}/application/sendKey?code=70"
+    )
+  end
+
+  it "should properly commnicate its  #send_virtual_key method" do
+    assert @client.send_virtual_key(70)
+    FakeWeb.last_request.path.must_equal(
+      "/system/players/#{@client.name}/application/sendVirtualKey?code=70"
+    )
+  end
+
+  it "should remember its parent (server)" do
+    @client.server.must_equal @server
+  end
+
+end
+
+

data/test/test_episode.rb

@@ -3,7 +3,8 @@ require 'test_helper'
 describe Plex::Episode do
 
   before do
-    @episode = Plex::Episode.new(FakeParent.new, '/libary/metadata/6')
+    @season = FakeParent.new
+    @episode = Plex::Episode.new(@season, '/libary/metadata/6')
   end
 
   it "should pass the proper method calls to its video object" do
@@ -12,8 +13,7 @@ describe Plex::Episode do
       "@video", fake_video
     )
 
-    %w(studio type title title_sort content_rating summary rating view_count year 
-       tagline thumb art duration originally_available_at updated_at).each { |method|
+    (Plex::Video::ATTRIBUTES - %w(key)).map {|m| Plex.snake_case(m) }.each { |method|
       @episode.send(method.to_sym).must_equal fake_video.send(method.to_sym)
     }
     
@@ -29,4 +29,8 @@ describe Plex::Episode do
 
   end
 
+  it "should remember its parent (season)" do
+    @episode.season.must_equal @season
+  end
+
 end

data/test/test_helper.rb

@@ -26,6 +26,15 @@ class FakeParent
 
 end
 
+FAKE_CLIENT_NODE_HASH = {
+  name: 'koslow.office',
+  host: '10.0.0.24',
+  address: '10.0.0.24',
+  port: '3000',
+  machine_identifier: 'f11283e2-a274-4c86-9a0a-23336c2d9e53',
+  version: '0.9.5.2-06ca164'
+}
+
 FAKE_SHOW_NODE_HASH = {
   Directory: FakeNode.new({
     guid: 'com.plexapp.agents.thetvdb://73545/1?lang=en',

data/test/test_library.rb

@@ -2,7 +2,8 @@ require 'test_helper'
 
 describe Plex::Library do
   before do
-    @library = Plex::Library.new(FakeParent.new)
+    @server = FakeParent.new
+    @library = Plex::Library.new(@server)
     @library.instance_variable_set("@xml_doc", FakeNode.new(FAKE_LIBRARY_NODE_HASH))
   end
 
@@ -18,4 +19,8 @@ describe Plex::Library do
       Plex::Section.new(nil, FakeNode.new(FAKE_SECTION_NODE_HASH))
     )
   end
+
+  it "should remember its parent (server)" do
+    @library.server.must_equal @server
+  end
 end

data/test/test_media.rb

@@ -5,8 +5,7 @@ describe Plex::Media do
     @media = Plex::Media.new( FakeNode.new(FAKE_MEDIA_NODE_HASH) )
   end
 
-  %w(id durration bitrate aspect_ratio audio_channels audio_codec video_codec 
-     video_resolution container video_frame_rate).each { |method|
+  Plex::Media::ATTRIBUTES.map {|m| Plex.snake_case(m) }.each { |method|
     it "should properly respond to ##{method}" do
       @media.send(method.to_sym).must_equal FAKE_MEDIA_NODE_HASH[method.to_sym]
     end

data/test/test_movie.rb

@@ -3,7 +3,8 @@ require 'test_helper'
 describe Plex::Movie do
 
   before do
-    @movie = Plex::Movie.new(FakeParent.new, '/libary/metadata/6')
+    @section = FakeParent.new
+    @movie = Plex::Movie.new(@section, '/libary/metadata/6')
   end
 
   it "should pass the proper method calls to its video object" do
@@ -12,8 +13,7 @@ describe Plex::Movie do
       "@video", fake_video
     )
 
-    %w(studio type title title_sort content_rating summary rating view_count year 
-       tagline thumb art duration originally_available_at updated_at).each { |method|
+    (Plex::Video::ATTRIBUTES - %w(key)).map {|m| Plex.snake_case(m) }.each { |method|
       @movie.send(method.to_sym).must_equal fake_video.send(method.to_sym)
     }
     
@@ -29,4 +29,8 @@ describe Plex::Movie do
 
   end
 
+  it "should remember its parent (section)" do
+    @movie.section.must_equal @section
+  end
+
 end

data/test/test_part.rb

@@ -5,7 +5,7 @@ describe Plex::Part do
     @part = Plex::Part.new( FakeNode.new(FAKE_PART_NODE_HASH) )
   end
 
-  %w(id key duration file size).each { |method|
+  Plex::Part::ATTRIBUTES.map {|m| Plex.snake_case(m) }.each { |method|
     it "should properly respond to ##{method}" do
       @part.send(method.to_sym).must_equal FAKE_PART_NODE_HASH[method.to_sym]
     end

data/test/test_season.rb

@@ -2,7 +2,8 @@ require 'test_helper'
 
 describe Plex::Season do
   before do
-    @season = Plex::Season.new(FakeParent.new, '/library/metadata/10')
+    @show = FakeParent.new
+    @season = Plex::Season.new(@show, '/library/metadata/10')
     @season.instance_variable_set("@xml_doc", FakeNode.new(FAKE_SEASON_NODE_HASH))
   end
 
@@ -21,4 +22,8 @@ describe Plex::Season do
     )
   end
 
+  it "should remember its parent (show)" do
+    @season.show.must_equal @show
+  end
+
 end

data/test/test_section.rb

@@ -2,12 +2,18 @@ require 'test_helper'
 
 describe Plex::Section do
   before do
-    @section = Plex::Section.new(FakeParent.new, FakeNode.new(FAKE_SECTION_NODE_HASH))
+    @library = FakeParent.new
+    @section = Plex::Section.new(@library, FakeNode.new(FAKE_SECTION_NODE_HASH))
   end
 
-  %w(refreshing type title art agent scanner language updated_at).each { |method|
+  (Plex::Section::ATTRIBUTES - %w(key)).map{|m| Plex.snake_case(m)}.each { |method|
     it "should respond to ##{method}" do
       @section.send(method.to_sym).must_equal FAKE_SECTION_NODE_HASH[method.to_sym]
     end
   }
+
+  it "should remember its parent (library)" do
+    @section.library.must_equal @library
+  end
+
 end

data/test/test_show.rb

@@ -2,7 +2,8 @@ require 'test_helper'
 
 describe Plex::Show do
   before do
-    @show = Plex::Show.new(FakeParent.new, '/library/metadata/10')
+    @section = FakeParent.new
+    @show = Plex::Show.new(@section, '/library/metadata/10')
     @show.instance_variable_set("@xml_doc", FakeNode.new(FAKE_SHOW_NODE_HASH))
   end
 
@@ -21,4 +22,8 @@ describe Plex::Show do
     )
   end
 
+  it "should remember its parent (section)" do
+    @show.section.must_equal @section
+  end
+
 end

data/test/test_stream.rb

@@ -5,7 +5,7 @@ describe Plex::Stream do
     @stream = Plex::Stream.new( FakeNode.new(FAKE_STREAM_NODE_HASH) )
   end
 
-  %w(id stream_type codec index language language_code).each { |method|
+  Plex::Stream::ATTRIBUTES.map{|m| Plex.snake_case(m)}.each { |method|
     it "should properly respond to ##{method}" do
       @stream.send(method.to_sym).must_equal FAKE_STREAM_NODE_HASH[method.to_sym]
     end

data/test/test_video.rb

@@ -6,8 +6,7 @@ describe Plex::Video do
     @video = Plex::Video.new( FakeNode.new(FAKE_VIDEO_NODE_HASH) )
   end
 
-  %w(key studio type title title_sort content_rating summary rating view_count year 
-     tagline thumb art duration originally_available_at updated_at).each { |method|
+  Plex::Video::ATTRIBUTES.map {|m| Plex.snake_case(m) }.each { |method|
     it "should correctly respond to ##{method}" do
       @video.send(method.to_sym).must_equal FAKE_VIDEO_NODE_HASH[method.to_sym]
     end

metadata

@@ -2,7 +2,7 @@
 name: plex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Eric Koslow
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-09 00:00:00 -05:00
+date: 2011-12-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -33,8 +33,30 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Extracts the Plex API into easy to write ruby code
 email: 
 - ekoslow@gmail.com
@@ -46,6 +68,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -57,7 +80,6 @@ files:
 - lib/plex-ruby/library.rb
 - lib/plex-ruby/media.rb
 - lib/plex-ruby/movie.rb
-- lib/plex-ruby/null.rb
 - lib/plex-ruby/parser.rb
 - lib/plex-ruby/part.rb
 - lib/plex-ruby/season.rb

data/lib/plex-ruby/null.rb

@@ -1,13 +0,0 @@
-class Null
-
-  def self.to_s; "" end
-  def self.to_i; 0 end
-  def self.to_a; [] end
-  def self.to_f; 0.0 end
-  def self.!@; true end
-  def self.nil?; true end
-  def self.present?; false end
-  def self.blank?; true end
-  def self.empty?; true end
-
-end