plex-ruby 0.3.1 → 1.0.0

data/CHANGELOG.md

@@ -19,3 +19,13 @@
 
 * Now allows for multiple servers
 * Fix a misspelling of 'library' that broke the gem (Sorry!)
+
+## 0.3.1
+
+* Fix `gem install plex-ruby`, require `open-uri` as a runtime dependecy 
+  wasn't a good idea
+
+## 1.0.0
+
+* Added a test suite that can be run with `rake`
+* I feel this a production ready, will continue to add features

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |i|
+  i.libs << 'test'
+  i.test_files = FileList['test/test_*.rb']
+end
+
+task default: :test
+

data/lib/plex-ruby/episode.rb

@@ -24,6 +24,14 @@ module Plex
       season.url
     end
 
+    def ==(other)
+      if other.is_a? Plex::Episode
+        key == other.key
+      else
+        super
+      end
+    end
+
     private
 
     def xml_doc

data/lib/plex-ruby/library.rb

@@ -41,6 +41,14 @@ module Plex
       server.url
     end
 
+    def ==(other)
+      if other.is_a? Library
+        server == other.server
+      else
+        super
+      end
+    end
+
     private
 
     def search_sections(doc, key = nil)

data/lib/plex-ruby/media.rb

@@ -21,5 +21,13 @@ module Plex
       @parts = node.search("Part").map { |m| Plex::Part.new(m) }
     end
 
+    def ==(other)
+      if other.is_a? Media
+        id == other.id
+      else
+        super
+      end
+    end
+
   end
 end

data/lib/plex-ruby/part.rb

@@ -12,7 +12,15 @@ module Plex
       @file     = node.attr('file')
       @size     = node.attr('size')
 
-      @streams  = node.search('Stream').map { |m| Stream.new(m) }
+      @streams  = node.search('Stream').map { |m| Plex::Stream.new(m) }
+    end
+
+    def ==(other)
+      if other.is_a? Plex::Part
+        id == other.id
+      else
+        super
+      end
     end
 
   end

data/lib/plex-ruby/season.rb

@@ -43,6 +43,14 @@ module Plex
       show.url
     end
 
+    def ==(other)
+      if other.is_a? Plex::Season
+        key == other.key
+      else
+        super
+      end
+    end
+
     private
 
     def base_doc

data/lib/plex-ruby/section.rb

@@ -3,7 +3,7 @@ module Plex
 
     GROUPS = %w(all unwatched newest recentlyAdded recentlyViewed onDeck)
 
-    attr_reader :library, :refreshing, :type, :title, :art, :agent, :scanner, 
+    attr_reader :library, :refreshing, :key, :type, :title, :art, :agent, :scanner, 
       :language, :updated_at
 
     # @param [Library] library this Section belongs to
@@ -53,5 +53,13 @@ module Plex
       library.url
     end
 
+    def ==(other)
+      if other.is_a? Plex::Section
+        key == other.key
+      else
+        super
+      end
+    end
+
   end
 end

data/lib/plex-ruby/show.rb

@@ -40,6 +40,14 @@ module Plex
       section.url
     end
 
+    def ==(other)
+      if other.is_a? Plex::Show
+        key == other.key
+      else
+        super
+      end
+    end
+
     private
 
     def base_doc

data/lib/plex-ruby/stream.rb

@@ -14,5 +14,13 @@ module Plex
       @language_code  = node.attr('language_code')
     end
 
+    def ==(other)
+      if other.is_a? Plex::Stream
+        id == other.id
+      else
+        super
+      end
+    end
+
   end
 end

data/lib/plex-ruby/tags.rb

@@ -10,6 +10,14 @@ module Plex
       @tag = node.attr('tag')
     end
 
+    def ==(other)
+      if other.is_a? #{type}
+        id == other.id
+      else
+        super
+      end
+    end
+
   end
 end
 CLASS
@@ -26,5 +34,13 @@ module Plex
       @role = node.attr('role')
     end
 
+    def ==(other)
+      if other.is_a? Role
+        id == other.id
+      else
+        super
+      end
+    end
+
   end
 end

data/lib/plex-ruby/version.rb

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

data/lib/plex-ruby/video.rb

@@ -18,14 +18,14 @@ module Plex
       @content_rating           = node.attr('contentRating')
       @summary                  = node.attr('summary')
       @rating                   = node.attr('rating')
-      @viewCount                = node.attr('viewCount')
+      @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')
-      @updatedAt                = node.attr('updatedAt')
+      @updated_at               = node.attr('updatedAt')
 
       @media      = Plex::Media.new(node.search('Media').first)
       @genres     = node.search('Genre').map    { |m| Plex::Genre.new(m)    }
@@ -34,5 +34,14 @@ module Plex
       @roles      = node.search('Role').map     { |m| Plex::Role.new(m)     } 
     end
 
+
+    def ==(other)
+      if other.is_a? Video
+        key == other.key
+      else
+        super
+      end
+    end
+
   end
 end

data/plex-ruby.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Eric Koslow"]
   s.email       = ["ekoslow@gmail.com"]
-  s.homepage    = ""
+  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}
 

data/test/test_episode.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+describe Plex::Episode do
+
+  before do
+    @episode = Plex::Episode.new(FakeParent.new, '/libary/metadata/6')
+  end
+
+  it "should pass the proper method calls to its video object" do
+    fake_video = Plex::Video.new( FakeNode.new(FAKE_VIDEO_NODE_HASH) )
+    @episode.instance_variable_set(
+      "@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|
+      @episode.send(method.to_sym).must_equal fake_video.send(method.to_sym)
+    }
+    
+    @episode.media.must_equal fake_video.media
+
+    @episode.genres.must_equal fake_video.genres
+
+    @episode.writers.must_equal fake_video.writers
+
+    @episode.directors.must_equal fake_video.directors
+
+    @episode.roles.must_equal fake_video.roles
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,166 @@
+require 'plex-ruby'
+require 'minitest/autorun'
+
+
+class FakeNode
+
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def attr(value)
+    @hash[Plex.snake_case(value).to_sym]
+  end
+
+  def search(value)
+    Array( @hash[value.to_sym] )
+  end
+
+end
+
+class FakeParent
+
+  def url
+    'http://localhost:32400'
+  end
+
+end
+
+FAKE_SHOW_NODE_HASH = {
+  Directory: FakeNode.new({
+    guid: 'com.plexapp.agents.thetvdb://73545/1?lang=en',
+    studio: 'Big Dog',
+    title: 'Friends',
+    content_rating: 'MV-14',
+    summary: '3 friends go on an adventure',
+    index: '1',
+    rating: '10',
+    year: '3033',
+    thumb: '/file/path.jpg',
+    art: '/other/file/path.png',
+    banner: '/yet/another/file/path.jpg2000',
+    theme: 'Chrismasy?',
+    duration: '2345234',
+    originally_available_at: '1323213639',
+    leaf_count: '1',
+    viewed_leaf_count: '0',
+    added_at: '1323213639',
+    updated_at: '1323220437',
+  })
+}
+
+FAKE_SEASON_NODE_HASH = {
+  Directory: FakeNode.new({
+    key: '/library/metadata/10/children',
+    rating_key: '10',
+    guid: 'com.plexapp.agents.thetvdb://73545/1?lang=en', 
+    type: 'season',
+    title: 'Season 1',
+    summary: '',
+    index: '1',
+    thumb: '/library/metadata/10/thumb?t=1323220437',
+    leaf_count: '13',
+    viewed_leaf_count: '0',
+    added_at: '1323213639',
+    updated_at: '1323220437'
+  })
+}
+
+FAKE_SECTION_NODE_HASH = {
+  refreshing: '0',
+  key: '1',
+  type: 'movie',
+  title: 'Movies',
+  art: '/:/resources/movie-fanart.jpg',
+  agent: 'com.plexapp.agents.imdb',
+  scanner: 'Plex Movie Scanner',
+  language: 'en',
+  updated_at: '1323213684'
+}
+
+FAKE_LIBRARY_NODE_HASH = {
+  :Directory => FakeNode.new(FAKE_SECTION_NODE_HASH),
+  :"Directory[@key='#{FAKE_SECTION_NODE_HASH[:key]}']" =>  FakeNode.new(FAKE_SECTION_NODE_HASH)
+}
+
+FAKE_STREAM_NODE_HASH = {
+  id: '100',
+  stream_type: 'fast',
+  codec: 'aac',
+  index: '5',
+  language: 'English',
+  language_code: 'en'
+}
+
+FAKE_PART_NODE_HASH = {
+  id: '45',
+  key: '1',
+  duration: '1600',
+  file: '/some/file/path/blah.mkv',
+  size: '6500',
+  Stream: FakeNode.new( FAKE_STREAM_NODE_HASH )
+}
+
+FAKE_MEDIA_NODE_HASH = {
+  id: '63',
+  durration: '3200',
+  bitrate: '24p',
+  aspect_ratio: '4:3',
+  audio_channels: '2',
+  audio_codec: 'mp3',
+  video_codec: 'mp4',
+  video_resolution: '720p',
+  container: 'mkv',
+  video_frame_rate: '32/2',
+  Part: FakeNode.new( FAKE_PART_NODE_HASH )
+}
+
+FAKE_GENRE_NODE_HASH = {
+  id: '13',
+  tag: 'Action'
+}
+
+FAKE_WRITER_NODE_HASH = {
+  id: '14',
+  tag: 'Poe'
+}
+
+FAKE_DIRECTOR_NODE_HASH = {
+  id: '15',
+  tag: 'King'
+}
+
+FAKE_ROLE_NODE_HASH = {
+  id: '16',
+  tag: 'Red Haired Person',
+  role: "Ron"
+}
+
+FAKE_VIDEO_NODE_HASH = {
+  rating_key: '7',
+  key: '/library/7', 
+  studio: 'Six', 
+  type: 'movie', 
+  title: 'Men in Black (2011)', 
+  title_sort: 'Men in Black', 
+  content_rating: 'MA', 
+  summary: 'Two men fight the entire world!', 
+  rating: '9.9', 
+  view_count: '0', 
+  year: '2011', 
+  tagline: 'Fight the Power!', 
+  thumb: '/some/long/filename.jpg', 
+  art: '/some/other/long/filename.jpg', 
+  duration: '3400', 
+  originally_available_at: '324124', 
+  updated_at: '342214', 
+  Media: FakeNode.new( FAKE_MEDIA_NODE_HASH ), 
+  Genre: FakeNode.new( FAKE_GENRE_NODE_HASH ), 
+  Writer: FakeNode.new( FAKE_WRITER_NODE_HASH ),
+  Director: FakeNode.new( FAKE_DIRECTOR_NODE_HASH ), 
+  Role: FakeNode.new( FAKE_ROLE_NODE_HASH )
+}
+
+FAKE_PARSER_NODE_HASH = {
+  MediaContainer: FakeNode.new(FAKE_VIDEO_NODE_HASH)
+}

data/test/test_library.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+describe Plex::Library do
+  before do
+    @library = Plex::Library.new(FakeParent.new)
+    @library.instance_variable_set("@xml_doc", FakeNode.new(FAKE_LIBRARY_NODE_HASH))
+  end
+
+
+  it "should return a list of sections" do
+    @library.sections.must_equal(
+      Array( Plex::Section.new(nil, FakeNode.new(FAKE_SECTION_NODE_HASH)) )
+    )
+  end
+
+  it "should return the proper section when specisfied" do
+    @library.section(FAKE_SECTION_NODE_HASH[:key]).must_equal(
+      Plex::Section.new(nil, FakeNode.new(FAKE_SECTION_NODE_HASH))
+    )
+  end
+end

data/test/test_media.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+describe Plex::Media do
+  before 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|
+    it "should properly respond to ##{method}" do
+      @media.send(method.to_sym).must_equal FAKE_MEDIA_NODE_HASH[method.to_sym]
+    end
+  }
+
+  it "should properly respond to #parts" do
+    @media.parts.must_equal Array( Plex::Part.new(FakeNode.new(FAKE_PART_NODE_HASH)) )
+  end
+
+end

data/test/test_movie.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+describe Plex::Movie do
+
+  before do
+    @movie = Plex::Movie.new(FakeParent.new, '/libary/metadata/6')
+  end
+
+  it "should pass the proper method calls to its video object" do
+    fake_video = Plex::Video.new( FakeNode.new(FAKE_VIDEO_NODE_HASH) )
+    @movie.instance_variable_set(
+      "@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|
+      @movie.send(method.to_sym).must_equal fake_video.send(method.to_sym)
+    }
+    
+    @movie.media.must_equal fake_video.media
+
+    @movie.genres.must_equal fake_video.genres
+
+    @movie.writers.must_equal fake_video.writers
+
+    @movie.directors.must_equal fake_video.directors
+
+    @movie.roles.must_equal fake_video.roles
+
+  end
+
+end

data/test/test_part.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+describe Plex::Part do
+  before do
+    @part = Plex::Part.new( FakeNode.new(FAKE_PART_NODE_HASH) )
+  end
+
+  %w(id key duration file size).each { |method|
+    it "should properly respond to ##{method}" do
+      @part.send(method.to_sym).must_equal FAKE_PART_NODE_HASH[method.to_sym]
+    end
+  }
+
+  it "should properly respond to #streams" do
+    @part.streams.must_equal Array( Plex::Stream.new(FakeNode.new(FAKE_STREAM_NODE_HASH)) )
+  end
+
+end
+

data/test/test_plex.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+describe Plex do
+
+  it "converts words from camelCase to snake_case" do
+    Plex.snake_case("camelCase").must_equal "camel_case"
+    Plex.snake_case("snake_case").must_equal "snake_case"
+    Plex.snake_case("normal").must_equal "normal"
+  end
+
+end

data/test/test_season.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+describe Plex::Season do
+  before do
+    @season = Plex::Season.new(FakeParent.new, '/library/metadata/10')
+    @season.instance_variable_set("@xml_doc", FakeNode.new(FAKE_SEASON_NODE_HASH))
+  end
+
+  Plex::Season::ATTRIBUTES.map{|m| Plex.snake_case(m)}.each { |method|
+    it "should properly respond to ##{method}" do
+      @season.send(method.to_sym).must_equal FAKE_SEASON_NODE_HASH[:Directory].attr(method)
+    end
+  }
+
+  it "should return a list of episodes" do
+    @season.instance_variable_set(
+      "@children", FakeNode.new({Video: FakeNode.new(FAKE_VIDEO_NODE_HASH)})
+    )
+    @season.episodes.must_equal(
+      [ Plex::Episode.new(FakeParent.new, FAKE_VIDEO_NODE_HASH[:key]) ]
+    )
+  end
+
+end

data/test/test_section.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe Plex::Section do
+  before do
+    @section = Plex::Section.new(FakeParent.new, FakeNode.new(FAKE_SECTION_NODE_HASH))
+  end
+
+  %w(refreshing type title art agent scanner language updated_at).each { |method|
+    it "should respond to ##{method}" do
+      @section.send(method.to_sym).must_equal FAKE_SECTION_NODE_HASH[method.to_sym]
+    end
+  }
+end

data/test/test_server.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+describe Plex::Server do
+  before do
+    @server = Plex::Server.new('localhost', 3000)
+  end
+
+  it "has a host" do
+    @server.host.must_equal 'localhost'
+  end
+
+  it "has a port" do
+    @server.port.must_equal 3000
+  end
+
+  it "properly formats its url" do
+    @server.url.must_equal "http://localhost:3000"
+  end
+
+  it "has a libary" do
+    @server.library.must_equal Plex::Library.new(@server)
+  end
+
+end

data/test/test_show.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+describe Plex::Show do
+  before do
+    @show = Plex::Show.new(FakeParent.new, '/library/metadata/10')
+    @show.instance_variable_set("@xml_doc", FakeNode.new(FAKE_SHOW_NODE_HASH))
+  end
+
+  Plex::Show::ATTRIBUTES.map{|m| Plex.snake_case(m)}.each { |method|
+    it "should properly respond to ##{method}" do
+      @show.send(method.to_sym).must_equal FAKE_SHOW_NODE_HASH[:Directory].attr(method)
+    end
+  }
+
+  it "should return a list of episodes" do
+    @show.instance_variable_set(
+      "@children", FakeNode.new(FAKE_SEASON_NODE_HASH)
+    )
+    @show.seasons.must_equal(
+      [ Plex::Season.new(FakeParent.new, FAKE_SEASON_NODE_HASH[:Directory].attr('key')[0..-10]) ]
+    )
+  end
+
+end

data/test/test_stream.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+describe Plex::Stream do
+  before do
+    @stream = Plex::Stream.new( FakeNode.new(FAKE_STREAM_NODE_HASH) )
+  end
+
+  %w(id stream_type codec index language language_code).each { |method|
+    it "should properly respond to ##{method}" do
+      @stream.send(method.to_sym).must_equal FAKE_STREAM_NODE_HASH[method.to_sym]
+    end
+  }
+
+end
+
+

data/test/test_video.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe Plex::Video do
+
+  before 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|
+    it "should correctly respond to ##{method}" do
+      @video.send(method.to_sym).must_equal FAKE_VIDEO_NODE_HASH[method.to_sym]
+    end
+  }
+  
+  it "should correctly referance its media object" do
+    @video.media.must_equal Plex::Media.new(FAKE_VIDEO_NODE_HASH[:Media])
+  end
+
+  it "should correctly referance its genre objects" do
+    @video.genres.must_equal Array( Plex::Genre.new(FAKE_VIDEO_NODE_HASH[:Genre]) )
+  end
+
+  it "should correctly referance its writer objects" do
+    @video.writers.must_equal Array( Plex::Writer.new(FAKE_VIDEO_NODE_HASH[:Writer]) )
+  end
+
+  it "should correctly referance its director objects" do
+    @video.directors.must_equal Array( Plex::Director.new(FAKE_VIDEO_NODE_HASH[:Director]) )
+  end
+
+  it "should correctly referance its role objects" do
+    @video.roles.must_equal Array( Plex::Role.new(FAKE_VIDEO_NODE_HASH[:Role]) )
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: plex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Eric Koslow
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-08 00:00:00 -05:00
+date: 2011-12-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,9 +69,22 @@ files:
 - lib/plex-ruby/version.rb
 - lib/plex-ruby/video.rb
 - plex-ruby.gemspec
+- test/test_client.rb
+- test/test_episode.rb
 - test/test_helper.rb
+- test/test_library.rb
+- test/test_media.rb
+- test/test_movie.rb
+- test/test_part.rb
+- test/test_plex.rb
+- test/test_season.rb
+- test/test_section.rb
+- test/test_server.rb
+- test/test_show.rb
+- test/test_stream.rb
+- test/test_video.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/ekosz/Plex-Ruby
 licenses: []
 
 post_install_message: 
@@ -99,4 +112,17 @@ signing_key:
 specification_version: 3
 summary: Plex APIs in easy ruby code
 test_files: 
+- test/test_client.rb
+- test/test_episode.rb
 - test/test_helper.rb
+- test/test_library.rb
+- test/test_media.rb
+- test/test_movie.rb
+- test/test_part.rb
+- test/test_plex.rb
+- test/test_season.rb
+- test/test_section.rb
+- test/test_server.rb
+- test/test_show.rb
+- test/test_stream.rb
+- test/test_video.rb