plex-ruby 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.1.alpha
+
+* Initial Release
+* Browsing a library works
+* Sending commands to a clients works intermittently, needs lots of work

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in plex-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Eric Koslow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Plex-Ruby
+
+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
+up-to-date as possible, but pull requests are always welcomed.
+
+
+## Installation
+
+Add to your `Gemfile` and run the `bundle` command
+
+```ruby
+gem 'plex-ruby'
+```
+
+I developed this using Ruby 1.9.2 so no guaranties that it will work with
+lesser versions of Ruby.
+
+## Usage
+
+Everything Stems from the Plex MediaServer. Create a server with the host and
+port number.
+
+```ruby
+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
+````
+
+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
+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.
+
+## Development
+
+All development of this gem takes place on its GitHub page. There you can
+create issues or submit pull requests.
+
+When submiting a pull request please write tests for your changes as well as
+use feature branches. Thank you!
+
+This gem was created by Eric Koslow and is under the MIT Licence.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/plex-ruby.rb

@@ -0,0 +1,39 @@
+require 'nokogiri'
+require 'open-uri'
+require 'cgi'
+
+module Plex
+
+  def self.snake_case(string)
+    string.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  def self.url
+    @@base_url
+  end
+
+  def self.url=(val)
+    @@base_url = val
+  end
+
+end
+
+require 'plex-ruby/parser'
+require 'plex-ruby/server'
+require 'plex-ruby/client'
+require 'plex-ruby/libary'
+require 'plex-ruby/section'
+require 'plex-ruby/video'
+require 'plex-ruby/media'
+require 'plex-ruby/part'
+require 'plex-ruby/stream'
+require 'plex-ruby/tags'
+require 'plex-ruby/show'
+require 'plex-ruby/season'
+require 'plex-ruby/episode'
+require 'plex-ruby/movie'
+

data/lib/plex-ruby/client.rb

@@ -0,0 +1,79 @@
+module Plex
+  class Client
+
+    attr_reader :name, :host, :address, :port, :machine_identifier, :version
+
+    def initialize(node)
+      @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')
+    end
+
+    %w(moveUp moveDown moveLeft moveRight pageUp pageDown nextLetter previousLetter 
+       select back contextMenu toggleOSD).each { |nav|
+      class_eval %(
+        def #{Plex.snake_case(nav)}
+          ping player_url+'/navigation/#{nav}'
+        end
+      )
+    }
+
+    %w(play pause stop rewind fastForward stepForward bigStepForward stepBack 
+       bigStepBack skipNext skipPrevious).each { |playback|
+      class_eval %(
+        def #{Plex.snake_case(playback)}
+          ping player_url+'/playback/#{playback}'
+        end
+      )
+    }
+
+    def play_file
+      ping player_url+"/application/playFile"
+    end
+
+    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 += "&key=#{CGI::escape(key)}"
+      url += "&userAgent=#{user_agent}" if user_agent
+      url += "&httpCookies=#{http_cookies}" if http_cookies
+      url += "&viewOffset=#{view_offset}" if view_offset
+
+      ping url
+    end
+
+    def screenshot(width, height, quality)
+      url = player_url+'/application/screenshot?'
+      url += "width=#{width}"
+      url += "&height=#{height}"
+    end
+
+    def send_string(text)
+      ping player_url+"/application/sendString?text=#{CGI::escape(text)}"
+    end
+
+    def send_key(code)
+      ping player_url+"/application/sendKey?code=#{CGI::escape(code)}"
+    end
+
+    def send_virtual_key(code)
+      ping player_url+"/application/sendVirtualKey?code=#{CGI::escape(code)}"
+    end
+
+    private
+
+    def player_url
+      Plex.url+"/system/players/#{name}"
+    end
+
+    def ping(url)
+      !!open(url).read
+    rescue => e
+      puts "Error trying to ping #{url} - #{e.message}"
+    end
+
+  end
+end

data/lib/plex-ruby/episode.rb

@@ -0,0 +1,29 @@
+module Plex
+  class Episode
+
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+    
+    def method_missing(method, *args, &block)
+      if video.respond_to? method
+        video.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    private
+
+    def xml_doc
+      @xml_doc ||= Nokogiri::XML( open(Plex.url+key) )
+    end
+
+    def video
+      @video ||= Plex::Video.new(xml_doc.search('Video').first)
+    end
+
+  end
+end

data/lib/plex-ruby/libary.rb

@@ -0,0 +1,25 @@
+module Plex
+  class Libary
+
+    def section(id)
+      xml_doc.search("Directory[@key='#{id}']").map do |m| 
+        Plex::Section.new(m.attributes) 
+      end.first
+    end
+
+    def sections
+      xml_doc.search('Directory').map { |m| Plex::Section.new(m.attributes) }
+    end
+
+    def key
+      "/library/sections"
+    end
+
+    private
+
+    def xml_doc
+      @xml_doc ||= Nokogiri::XML( open(Plex.url+key) )
+    end
+
+  end
+end

data/lib/plex-ruby/media.rb

@@ -0,0 +1,23 @@
+module Plex
+  class Media
+    attr_reader :id, :durration, :bitrate, :aspect_ratio, :audio_channels,
+      :audio_codec, :video_codec, :video_resolution, :container, :video_frame_rate,
+      :parts
+
+    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')
+
+      @parts = node.search("Part").map { |m| Plex::Part.new(m) }
+    end
+
+  end
+end

data/lib/plex-ruby/movie.rb

@@ -0,0 +1,29 @@
+module Plex
+  class Movie
+
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def method_missing(method, *args, &block)
+      if video.respond_to? method
+        video.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    private
+
+    def xml_doc
+      @xml_doc ||= Nokogiri::XML( open(Plex.url+key) )
+    end
+
+    def video
+      @video ||= Plex::Video.new(xml_doc.search('Video').first)
+    end
+
+  end
+end

data/lib/plex-ruby/null.rb

@@ -0,0 +1,13 @@
+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

data/lib/plex-ruby/parser.rb

@@ -0,0 +1,62 @@
+module Plex
+  class Parser
+
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+    end
+
+    def parse
+      case node.name
+      when 'document'
+        Plex::Parser.new(node.root).parse
+      when 'MediaContainer'
+        parse_media_container
+      when 'Video'
+        parse_video
+      when 'Directory'
+        parse_directory
+      when 'text'
+        nil
+      else
+      end
+    end
+
+    private
+
+    def parse_media_container
+      return nil if node.attr('size').to_i == 0
+      node.children.map {|m| Plex::Parser.new(m).parse }.compact
+    end
+
+    def parse_video
+      case node.attr('type')
+      when 'movie'
+        parse_movie
+      when 'episode'
+        parse_episode
+      else
+        raise 'Unsupported Video Type!'
+      end
+    end
+
+    def parse_movie
+      Plex::Movie.new( node.attr('key') )
+    end
+
+    def parse_episode
+      Plex::Episode.new( node.attr('key') )
+    end
+
+    def parse_directory
+      case node.attr('type')
+      when 'show'
+        Plex::Show.new( node.attr('key')[0..-10] ) # Remove /children
+      else
+        raise "Unsupported Directory type #{node.attr('type')}"
+      end
+    end
+  end
+end
+

data/lib/plex-ruby/part.rb

@@ -0,0 +1,17 @@
+module Plex
+  class Part
+
+    attr_reader :id, :key, :duration, :file, :size, :streams
+
+    def initialize(node)
+      @id       = node.attr('id')
+      @key      = node.attr('key')
+      @duration = node.attr('duration')
+      @file     = node.attr('file')
+      @size     = node.attr('size')
+
+      @streams  = node.search('Stream').map { |m| Stream.new(m) }
+    end
+
+  end
+end

data/lib/plex-ruby/season.rb

@@ -0,0 +1,38 @@
+module Plex
+  # Found at /libary/metadata/:key
+  class Season
+
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    %w(ratingKey guid type title summary index thumb leafCount viewedLeafCount 
+       addedAt updatedAt).each { |method|
+      class_eval %(
+        def #{Plex.snake_case(method)}; directory.attr('#{method}') end
+      )
+    }
+
+    def episodes
+      @episodes ||=
+        children.search("Video").map { |m| Plex::Episode.new(m.attr('key')) }
+    end
+
+    private
+
+    def xml_doc
+      @xml_doc ||= Nokogiri::XML( open(Plex.url+key) )
+    end
+
+    def children 
+      @children ||= Nokogiri::XML( open(Plex.url+key+'/children') )
+    end
+
+    def directory
+      @directory ||= xml_doc.search("Directory").first
+    end
+
+  end
+end

data/lib/plex-ruby/section.rb

@@ -0,0 +1,36 @@
+module Plex
+  class Section
+
+    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
+    end
+
+    def refresh(deep = false, force = false)
+    end
+
+
+    %w(all unwatched newest recentlyAdded recentlyViewed onDeck).each { |method|
+      class_eval %(
+        def #{Plex.snake_case(method)}
+          Plex::Parser.new( Nokogiri::XML(open(Plex.url+key+'/#{method}')) ).parse
+        end
+      )
+    }
+
+    def key
+      "/library/sections/#{@key}"
+    end
+
+  end
+end

data/lib/plex-ruby/server.rb

@@ -0,0 +1,30 @@
+module Plex
+  class Server
+
+    attr_reader :host, :port
+
+    def initialize(host, port)
+      @host = host
+      @port = port
+      Plex.url = "http://#{host}:#{port}"
+    end
+
+    def system
+    end
+
+    def libary
+      @libary ||= Plex::Libary.new
+    end
+
+    def clients
+      @clients ||= clients_doc.search('Server').map { |m| Plex::Client.new(m) }
+    end
+
+    private
+
+    def clients_doc
+      @clients_doc ||= Nokogiri::XML( open(Plex.url+'/clients') )
+    end
+
+  end
+end

data/lib/plex-ruby/show.rb

@@ -0,0 +1,42 @@
+module Plex
+  # Found at /libary/metadata/:key
+  class Show
+
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    %w(guid studio title contentRating summary index rating year thumb art banner
+       theme duration originallyAvailableAt leafCount viewedLeafCount addedAt
+       updatedAt).each { |method|
+      class_eval %(
+        def #{Plex.snake_case(method)}; @#{method} ||= directory.attr('#{method}') end
+      )
+    }
+
+    def seasons
+      @seasons ||=
+        children.search('Directory').map do |season|
+          Plex::Season.new(season.attr('key')[0..-10]) # Remove /children
+        end.compact
+    end
+
+    private
+
+    def children
+      @children ||= Nokogiri::XML( open(Plex.url+key+'/children') )
+    end
+
+    def directory
+      @directory ||= xml_doc.search('Directory').first
+    end
+    
+    def xml_doc
+      @xml_doc ||= Nokogiri::XML( open(Plex.url+key) )
+    end
+
+  end
+
+end

data/lib/plex-ruby/stream.rb

@@ -0,0 +1,16 @@
+module Plex
+  class Stream
+
+    attr_reader :id, :stream_type, :codec, :index, :language, :language_code
+
+    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')
+    end
+
+  end
+end

data/lib/plex-ruby/tags.rb

@@ -0,0 +1,30 @@
+%w(Genre Writer Director Country).each { |type|
+  eval <<-CLASS
+module Plex
+  class #{type}
+    
+    attr_reader :id, :tag
+
+    def initialize(node)
+      @id  = node.attr('id')
+      @tag = node.attr('tag')
+    end
+
+  end
+end
+CLASS
+}
+
+module Plex
+  class Role
+    
+    attr_reader :id, :tag, :role
+
+    def initialize(node)
+      @id   = node.attr('id')
+      @tag  = node.attr('tag')
+      @role = node.attr('role')
+    end
+
+  end
+end

data/lib/plex-ruby/version.rb

@@ -0,0 +1,3 @@
+module Plex
+  VERSION = "0.1.0"
+end

data/lib/plex-ruby/video.rb

@@ -0,0 +1,36 @@
+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
+
+    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')
+      @viewCount                = 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')
+      @updatedAt                = node.attr('updatedAt')
+
+      @media      = Plex::Media.new(node.search('Media').first)
+      @genres     = node.search('Genre').map    { |m| Plex::Genre.new(m)    }
+      @writers    = node.search('Writer').map   { |m| Plex::Writer.new(m)   }
+      @directors  = node.search('Director').map { |m| Plex::Director.new(m) } 
+      @roles      = node.search('Role').map     { |m| Plex::Role.new(m)     } 
+    end
+
+  end
+end

data/plex-ruby.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "plex-ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "plex-ruby"
+  s.version     = Plex::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Eric Koslow"]
+  s.email       = ["ekoslow@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Plex APIs in easy ruby code}
+  s.description = %q{Extracts the Plex API into easy to write ruby code}
+
+  s.rubyforge_project = "plex-ruby"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'minitest'
+  s.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'open-uri'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: plex-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eric Koslow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: open-uri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Extracts the Plex API into easy to write ruby code
+email: 
+- ekoslow@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/plex-ruby.rb
+- lib/plex-ruby/client.rb
+- lib/plex-ruby/episode.rb
+- lib/plex-ruby/libary.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
+- lib/plex-ruby/section.rb
+- lib/plex-ruby/server.rb
+- lib/plex-ruby/show.rb
+- lib/plex-ruby/stream.rb
+- lib/plex-ruby/tags.rb
+- lib/plex-ruby/version.rb
+- lib/plex-ruby/video.rb
+- plex-ruby.gemspec
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: plex-ruby
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Plex APIs in easy ruby code
+test_files: 
+- test/test_helper.rb