plex-ruby 1.5.1 → 1.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8866a7fbb96ee008c3f07d3f7fd350a03598eebd
+  data.tar.gz: 31c390b83a84299d6ddb8276e63bab13dae3726c
+SHA512:
+  metadata.gz: 4e1bf2dbca860b21b65fed8f45c8900ee8473fcc9afbeb2f67ea9c63c3516c72c97c83b78a30e35257596b4c8c796d7b3f345aeb0acdf91bf71f08733a5f7b9b
+  data.tar.gz: 192b84c99c0c7a8fcde09ef4322fb1fbd5a8635bc3612a1581c7147eb740502a2f9b54a0a5ca5679d019eff3eaa715a6be0622f2dcdfb028309ea4d51962462d

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 .rake_tasks~
 pkg/*
+*.swp

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.5.2
+* Added support for authentication token via `Plex.configure`
+
 ## 1.5.1
 * `Plex::Video` now supports multiple media entries (`@media` renamed to `@medias`)
 

data/README.md

@@ -24,6 +24,17 @@ require 'plex-ruby'
 I developed this using Ruby 1.9.2 so no guaranties that it will work with
 lesser versions of Ruby.
 
+## Configuration
+
+For external access to your Plex Media Server an auth token is required. You
+can configure it with the following snippet.
+
+```ruby
+Plex.configure do |config|
+  config.auth_token = "ABCDEFGH"
+end
+```
+
 ## Usage
 
 Everything Stems from the Plex Media Server. Create a server with the host and

data/lib/plex-ruby.rb

@@ -4,6 +4,30 @@ require 'cgi'
 
 module Plex
 
+  # Instantiates a Config instance once and returns it
+  def self.config
+    @config ||= Config.new
+  end
+
+  # Allows the configuration of some Plex-internal settings. It yields a Config
+  # instance so a block can be used:
+  #
+  #    Plex.configure do |config|
+  #      config.auth_token = "ABCDEF"
+  #    end
+  def self.configure
+    yield(config)
+  end
+
+  # Custom open func which adds the required headers configured by
+  # <tt>Plex.configure</tt>
+  def self.open(url)
+    headers = {}
+    headers["X-Plex-Token"] = config.auth_token if config.auth_token
+
+    super(url, headers)
+  end
+
   # Converts camel case names that are commonly found in the Plex APIs into
   # ruby friendly names.  I.E. <tt>playMedia</tt> -> <tt>play_media</tt>
   #
@@ -29,6 +53,7 @@ module Plex
 
 end
 
+require 'plex-ruby/config'
 require 'plex-ruby/parser'
 require 'plex-ruby/server'
 require 'plex-ruby/client'

data/lib/plex-ruby/client.rb

@@ -1,10 +1,10 @@
 module Plex
   class Client
 
-    NAV_METHODS = %w(moveUp moveDown moveLeft moveRight pageUp pageDown nextLetter 
-                     previousLetter select back contextMenu toggleOSD) 
+    NAV_METHODS = %w(moveUp moveDown moveLeft moveRight pageUp pageDown nextLetter
+                     previousLetter select back contextMenu toggleOSD)
 
-    PLAYBACK_METHODS = %w(play pause stop rewind fastForward stepForward 
+    PLAYBACK_METHODS = %w(play pause stop rewind fastForward stepForward
                           bigStepForward stepBack bigStepBack skipNext skipPrevious)
 
     ATTRIBUTES = %w(name host address port machineIdentifier version)
@@ -64,7 +64,7 @@ module Plex
     def play_media(key, user_agent = nil, http_cookies = nil, view_offset = nil)
 
       if !key.is_a?(String) && key.respond_to?(:key)
-        key = key.key 
+        key = key.key
       end
 
       url = player_url+'/application/playMedia?'
@@ -137,7 +137,7 @@ module Plex
     end
 
     def ping(url)
-      !!open(url).read
+      !!Plex.open(url).read
     rescue => e
       puts "Error trying to ping #{url} - #{e.message}"
     end

data/lib/plex-ruby/config.rb

@@ -0,0 +1,9 @@
+module Plex
+  class Config
+    attr_accessor :auth_token
+
+    def initialize
+      @auth_token = nil
+    end
+  end
+end

data/lib/plex-ruby/episode.rb

@@ -14,7 +14,7 @@ module Plex
     def attribute_hash
       video.attribute_hash.merge({'key' => key})
     end
-    
+
     # Delegates all method calls to the video object that represents this
     # episode, if that video object responds to the method.
     def method_missing(method, *args, &block)
@@ -55,7 +55,7 @@ module Plex
     private
 
     def xml_doc
-      @xml_doc ||= Nokogiri::XML( open(url+key) )
+      @xml_doc ||= Nokogiri::XML( Plex.open(url+key) )
     end
 
     def video

data/lib/plex-ruby/library.rb

@@ -73,7 +73,7 @@ module Plex
     end
 
     def base_doc
-      Nokogiri::XML( open(url+key) )
+      Nokogiri::XML( Plex.open(url+key) )
     end
 
 

data/lib/plex-ruby/movie.rb

@@ -46,7 +46,7 @@ module Plex
     private
 
     def xml_doc
-      @xml_doc ||= Nokogiri::XML( open(url+key) )
+      @xml_doc ||= Nokogiri::XML( Plex.open(url+key) )
     end
 
     def video

data/lib/plex-ruby/season.rb

@@ -2,8 +2,8 @@ module Plex
   # Found at /library/metadata/:key
   class Season
 
-    ATTRIBUTES = %w(ratingKey guid type title summary index thumb leafCount 
-                    viewedLeafCount addedAt updatedAt) 
+    ATTRIBUTES = %w(ratingKey guid type title summary index thumb leafCount
+                    viewedLeafCount addedAt updatedAt)
 
     attr_reader :show, :key, :attribute_hash
 
@@ -79,18 +79,18 @@ module Plex
     private
 
     def base_doc
-      Nokogiri::XML( open(url+key) )
+      Nokogiri::XML( Plex.open(url+key) )
     end
 
     def base_children_doc
-      Nokogiri::XML( open(url+key+'/children') )
+      Nokogiri::XML( Plex.open(url+key+'/children') )
     end
 
     def xml_doc
       @xml_doc ||= base_doc
     end
 
-    def children 
+    def children
       @children ||= base_children_doc
     end
 

data/lib/plex-ruby/section.rb

@@ -25,7 +25,7 @@ module Plex
     end
 
 
-    # Returns a list of shows or movies that are in this Section. 
+    # Returns a list of shows or movies that are in this Section.
     #
     # all - all videos in this Section
     # unwatched - videos unwatched in this Section
@@ -38,7 +38,7 @@ module Plex
     GROUPS.each { |method|
       class_eval %(
         def #{Plex.underscore(method)}
-          Plex::Parser.new( self, Nokogiri::XML(open(url+key+'/#{method}')) ).parse
+          Plex::Parser.new( self, Nokogiri::XML(Plex.open(url+key+'/#{method}')) ).parse
         end
       )
     }
@@ -51,7 +51,7 @@ module Plex
     #    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
@@ -71,7 +71,7 @@ module Plex
           @#{Plex.underscore(method)}s = grab_keys('#{method}')
         end
         def by_#{Plex.underscore(method)}(val)
-          Plex::Parser.new( self, Nokogiri::XML(open(url+key+"/#{method}/\#{val}")) ).parse
+          Plex::Parser.new( self, Nokogiri::XML(Plex.open(url+key+"/#{method}/\#{val}")) ).parse
         end
       )
     }
@@ -80,7 +80,7 @@ module Plex
     def key #:nodoc:
       "/library/sections/#{@key}"
     end
-    
+
     # @private
     def url #:nodoc:
       library.url
@@ -103,7 +103,7 @@ module Plex
     private
 
     def grab_keys(action)
-      Nokogiri::XML(open(url+key+"/#{action}")).search('Directory').map do |node| 
+      Nokogiri::XML(Plex.open(url+key+"/#{action}")).search('Directory').map do |node|
         {
           key: node.attr('key'),
           title: node.attr('title')

data/lib/plex-ruby/server.rb

@@ -16,7 +16,7 @@ module Plex
     end
 
     # The Plex clients that are connected to this Server
-    # 
+    #
     # @return [Array] list of Clients connected to this server
     def clients
       @clients ||= search_clients clients_doc
@@ -40,7 +40,7 @@ module Plex
     private
 
     def clients_base
-      Nokogiri::XML( open(url+'/clients') )
+      Nokogiri::XML( Plex.open(url+'/clients') )
     end
 
     def clients_doc

data/lib/plex-ruby/show.rb

@@ -1,8 +1,8 @@
 module Plex
   class Show
 
-    ATTRIBUTES = %w(ratingKey guid studio type title contentRating summary index 
-                    rating year thumb art leafCount viewedLeafCount addedAt 
+    ATTRIBUTES = %w(ratingKey guid studio type title contentRating summary index
+                    rating year thumb art leafCount viewedLeafCount addedAt
                     updatedAt)
 
     attr_reader :section, :key, :attribute_hash
@@ -44,7 +44,7 @@ module Plex
     end
 
     # Helper method for selecting the special Season of this show
-    # Season 0 is where Plex stores episodes that are not part of a 
+    # Season 0 is where Plex stores episodes that are not part of a
     # regular season. i.e. Christmas Specials
     #
     # @return [Season] season with index of 0
@@ -105,17 +105,17 @@ module Plex
     private
 
     def base_doc
-      Nokogiri::XML( open(url+key) )
+      Nokogiri::XML( Plex.open(url+key) )
     end
 
     def children_base
-      Nokogiri::XML( open(url+key+'/children') )
+      Nokogiri::XML( Plex.open(url+key+'/children') )
     end
 
     def xml_doc
       @xml_doc ||= base_doc
     end
-    
+
     def children
       @children ||= children_base
     end

data/lib/plex-ruby/version.rb

@@ -1,3 +1,3 @@
 module Plex
-  VERSION = "1.5.1"
+  VERSION = "1.5.2"
 end

data/test/test_config.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+describe Plex::Config do
+
+  it "should be configurable" do
+    Plex.config.auth_token.must_equal nil
+
+    Plex.configure do |config|
+      config.auth_token = "ABCD"
+    end
+
+    Plex.config.auth_token.must_equal "ABCD"
+  end
+end

data/test/test_plex.rb

@@ -8,4 +8,19 @@ describe Plex do
     Plex.underscore("normal").must_equal "normal"
   end
 
+  before do
+    FakeWeb.register_uri(:get, "http://localhost:32400", :body => "")
+  end
+
+  after do
+    FakeWeb.clean_registry
+    Plex.config.auth_token = nil
+  end
+
+  it "has an open function which respects the configuration" do
+    Plex.configure {|config| config.auth_token = "ABCD" }
+
+    Plex.open("http://localhost:32400").read
+    FakeWeb.last_request["X-Plex-Token"].must_equal "ABCD"
+  end
 end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: plex-ruby
 version: !ruby/object:Gem::Version
-  version: 1.5.1
-  prerelease: 
+  version: 1.5.2
 platform: ruby
 authors:
 - Eric Koslow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Extracts the Plex Media Server API into easy to write ruby code
@@ -82,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -91,6 +82,7 @@ files:
 - Rakefile
 - lib/plex-ruby.rb
 - lib/plex-ruby/client.rb
+- lib/plex-ruby/config.rb
 - lib/plex-ruby/episode.rb
 - lib/plex-ruby/library.rb
 - lib/plex-ruby/media.rb
@@ -107,6 +99,7 @@ files:
 - lib/plex-ruby/video.rb
 - plex-ruby.gemspec
 - test/test_client.rb
+- test/test_config.rb
 - test/test_episode.rb
 - test/test_helper.rb
 - test/test_library.rb
@@ -122,36 +115,30 @@ files:
 - test/test_video.rb
 homepage: https://github.com/ekosz/Plex-Ruby
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1533681294103733520
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1533681294103733520
 requirements: []
 rubyforge_project: plex-ruby
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Plex Media Server APIs in easy ruby code
 test_files:
 - test/test_client.rb
+- test/test_config.rb
 - test/test_episode.rb
 - test/test_helper.rb
 - test/test_library.rb