airvideo 0.0.6 → 0.0.7

data/README.rdoc

@@ -1,5 +1,5 @@
 = AirVideo for Ruby
-Have you ever thought to yourself: I have AirVideo (http://www.inmethod.com/air-video/) running on my computer and I enjoy it so much
+Have you ever thought to yourself: I have AirVideo[http://www.inmethod.com/air-video] running on my computer and I enjoy it so much
 that not only have I bought the iPhone and iPad apps, I'd also love to be able to watch my video on my laptop too?
 
 Me too! So I reverse engineered their communication protocol and came up with this. It's a little hacky (and it's certainly not been tested outside of Mac OS X 10.6)

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/airvideo.rb

@@ -14,17 +14,13 @@ module AirVideo
   # Setting #max_height and #max_width *should* be working with the Live Conversion, but for some reason it's not quite happening. Defaults are 640x480
   class Client
     attr_accessor :max_height, :max_width
+    attr_reader :proxy
     
     # Specify where your AirVideo Server lives. If your HTTP_PROXY environment variable is set, it will be honoured.
     #
     # At the moment I'm expecting ENV['HTTP_PROXY'] to have the form 'sub.domain.com:8080', I throw an http:// and bung it into URI.parse for convenience.
     def initialize(server,port = 45631,password=nil)
-      begin
-        proxy = URI.parse("http://"+ENV['HTTP_PROXY'])
-        @http = Net::HTTP::Proxy(proxy.host, proxy.port)
-      rescue
-        @http = Net::HTTP
-      end
+      set_proxy # Set to environment proxy settings, if applicable
       @endpoint = URI.parse "http://#{server}:#{port}/service"
       @passworddigest = Digest::SHA1.hexdigest("S@17" + password + "@1r").upcase if !password.nil?
       
@@ -40,7 +36,23 @@ module AirVideo
       @max_height = 480
     end
     
-    # Lists the folders and videos in the current directory as an Array of AirVideo::FileObject and AirVideo::FolderObject objects.
+    # Potentially confusing: 
+    # * Sending 'server:port' will use that address as an HTTP proxy
+    # * An empty string (or something not recognisable as a URL with http:// put infront of it) will try to use the ENV['HTTP_PROXY'] variable
+    # * Sending nil or any object that can't be parsed to a string will remove the proxy
+    #
+    # NB. You can access the @proxy URI object externally, but changing it will *not* automatically call set_proxy
+    def set_proxy(proxy_server_and_port = "")
+      begin
+        @proxy = URI.parse("http://"+((proxy_server_and_port.empty?) ? ENV['HTTP_PROXY'] : string_proxy))
+        @http = Net::HTTP::Proxy(@proxy.host, @proxy.port)
+      rescue
+        @proxy = nil
+        @http = Net::HTTP
+      end
+    end
+    
+    # Lists the folders and videos in the current directory as an Array of AirVideo::VideoObject and AirVideo::FolderObject objects.
     def ls(dir = ".")
       dir = dir.location if dir.is_a? FolderObject
       dir = File.expand_path(dir,@current_dir)[1..-1]
@@ -51,7 +63,7 @@ module AirVideo
           when "air.video.DiskRootFolder", "air.video.ITunesRootFolder","air.video.Folder"
             FolderObject.new(self,hash['name'],hash['itemId'])
           when "air.video.VideoItem","air.video.ITunesVideoItem"
-            FileObject.new(self,hash['name'],hash['itemId'],hash['detail'] || {})
+            VideoObject.new(self,hash['name'],hash['itemId'],hash['detail'] || {})
           else
             raise NotImplementedError, "Unknown: #{hash.name}"
           end
@@ -73,9 +85,9 @@ module AirVideo
       self
     end
     
-    # Returns the streaming video URL for the given AirVideo::FileObject.
+    # Returns the streaming video URL for the given AirVideo::VideoObject.
     def get_url(fileobj,liveconvert = false)
-      raise NoMethodError, "Please pass a FileObject" if not fileobj.is_a? FileObject
+      raise NoMethodError, "Please pass a VideoObject" if not fileobj.is_a? VideoObject
       begin
         if liveconvert
           request("livePlaybackService","initLivePlayback",[conversion_settings(fileobj)])['result']['contentURL']
@@ -158,7 +170,7 @@ module AirVideo
       attr_reader :name, :location
 
       # Shouldn't be used outside of the AirVideo module
-      def initialize(server,name,location)
+      def initialize(server,name,location) # :nodoc:
         @server = server
         @name = name
         @location = "/"+location
@@ -182,10 +194,11 @@ module AirVideo
     # Represents a video file as listed by the AirVideo server.
     #
     # Has helper functions like #url and #live_url which give the video playback URLs of this video, as produced by the originating AirVideo::Client instance's AirVideo::Client.get_url method.
-    class FileObject
+    class VideoObject
       attr_reader :name, :location, :details
 
-      def initialize(server,name,location,detail = {})
+      # Shouldn't be used outside of the AirVideo module
+      def initialize(server,name,location,detail = {}) # :nodoc:
         @server = server
         @name = name
         @location = "/"+location
@@ -301,8 +314,8 @@ module AirVideo
     class BinaryData
       attr_reader :data
 
-      # Not to be used outside of the AvMap module
-      def initialize(data)
+      # Not really useful outside of the AvMap module
+      def initialize(data) # :nodoc:
         @data = data
       end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: airvideo
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - JP Hastings-Spital
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-25 00:00:00 +01:00
+date: 2010-05-26 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -43,23 +44,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Allows communication with an AirVideo server