airplay 1.0.0.beta3 → 1.0.0

data/lib/airplay/cli/image_viewer.rb

@@ -0,0 +1,67 @@
+module Airplay
+  module CLI
+    class ImageViewer
+      attr_reader :options, :devices
+
+      def initialize(devices, options = {})
+        @devices = Array(devices)
+        @options = options
+      end
+
+      def view(file, transition = "SlideLeft")
+        puts "Showing #{file}"
+        devices.each do |device|
+          device.view(file, transition: transition)
+        end
+      end
+
+      def slideshow(files)
+        puts "Autoplay every #{options[:wait]}"
+        files.each do |file|
+          view(file)
+          sleep options[:wait]
+        end
+      end
+
+      def interactive(files)
+        numbers = Array(0...files.count)
+        transition = "None"
+
+        i = 0
+        loop do
+          view(files[i], transition)
+
+          case read_char
+          when "\e[C" # Right Arrow
+            i = i + 1 > numbers.count - 1 ? 0 : i + 1
+            transition = "SlideLeft"
+          when "\e[D" # Left Arrow
+            i = i - 1 < 0 ? numbers.count - 1 : i - 1
+            transition = "SlideRight"
+          else
+            break
+          end
+        end
+      end
+
+      private
+
+      def read_char
+        STDIN.echo = false
+        STDIN.raw!
+
+        input = STDIN.getc.chr
+        if input == "\e" then
+          input << STDIN.read_nonblock(3) rescue nil
+          input << STDIN.read_nonblock(2) rescue nil
+        end
+      ensure
+        STDIN.echo = true
+        STDIN.cooked!
+
+        return input
+      end
+
+    end
+  end
+end

data/lib/airplay/cli/version.rb

@@ -1,5 +1,5 @@
 module Airplay
-  class CLI
-    VERSION = "0.1.0.beta4"
+  module CLI
+    VERSION = "0.1.0"
   end
 end

data/lib/airplay/configuration.rb

@@ -1,6 +1,8 @@
 require "log4r/config"
 require "airplay/logger"
 
+# Public: Airplay core module
+#
 module Airplay
   # Public: Handles the Airplay configuration
   #
@@ -19,6 +21,8 @@ module Airplay
 
     # Public: Loads the configuration into the affected parts
     #
+    # Returns nothing.
+    #
     def load
       level = if @log_level.is_a?(Fixnum)
                 @log_level

data/lib/airplay/connection.rb

@@ -16,11 +16,19 @@ module Airplay
       @logger = Airplay::Logger.new("airplay::connection")
     end
 
+    # Public: Establishes a persistent connection to the device
+    #
+    # Returns the persistent connection
+    #
     def persistent
       address = @options[:address] || "http://#{@device.address}"
       @_persistent ||= Airplay::Connection::Persistent.new(address, @options)
     end
 
+    # Public: Closes the opened connection
+    #
+    # Returns nothing
+    #
     def close
       persistent.close
       @_persistent = nil
@@ -28,9 +36,9 @@ module Airplay
 
     # Public: Executes a POST to a resource
     #
-    #   resource - The resource on the currently active Device
-    #   body - The body of the action
-    #   headers - Optional headers
+    # resource - The resource on the currently active Device
+    # body     - The body of the action
+    # headers  - Optional headers
     #
     # Returns a response object
     #
@@ -44,9 +52,9 @@ module Airplay
 
     # Public: Executes a PUT to a resource
     #
-    #   resource - The resource on the currently active Device
-    #   body - The body of the action
-    #   headers - Optional headers
+    # resource - The resource on the currently active Device
+    # body     - The body of the action
+    # headers  - Optional headers
     #
     # Returns a response object
     #
@@ -60,8 +68,8 @@ module Airplay
 
     # Public: Executes a GET to a resource
     #
-    #   resource - The resource on the currently active Device
-    #   headers - Optional headers
+    # resource - The resource on the currently active Device
+    # headers  - Optional headers
     #
     # Returns a response object
     #
@@ -76,6 +84,8 @@ module Airplay
 
     # Private: The defaults connection headers
     #
+    # Returns the default headers
+    #
     def default_headers
       {
         "User-Agent"         => "MediaControl/1.0",
@@ -85,8 +95,8 @@ module Airplay
 
     # Private: Sends a request to the Device
     #
-    #   request - The Request object
-    #   headers - The headers of the request
+    # request - The Request object
+    # headers - The headers of the request
     #
     # Returns a response object
     #

data/lib/airplay/device.rb

@@ -20,44 +20,88 @@ module Airplay
       Airplay.configuration.load
     end
 
+    # Public: Access the ip of the device
+    #
+    # Returns the memoized ip address
+    #
     def ip
       @_ip ||= address.split(":").first
     end
 
+    # Public: Sets the password for the device
+    #
+    # passwd - The password string
+    #
+    # Returns nothing
+    #
     def password=(passwd)
       @password = passwd
     end
 
+    # Public: Checks if the devices has a password
+    #
+    # Returns boolean for the presence of a password
+    #
     def password?
       !!password && !password.empty?
     end
 
+    # Public: Set the addess of the device
+    #
+    # address - The address string of the device
+    #
+    # Returns nothing
+    #
     def address=(address)
       @address = address
     end
 
+    # Public: Access the Features of the device
+    #
+    # Returns the Featurs of the device
+    #
     def features
       @_features ||= Features.new(self)
     end
 
+    # Public: Access the Info of the device
+    #
+    # Returns the Info of the device
+    #
     def info
       @_info ||= Info.new(self)
     end
 
+    # Public: Access the full information of the device
+    #
+    # Returns a hash with all the information
+    #
     def server_info
       @_server_info ||= basic_info.merge(extra_info)
     end
 
+    # Public: Establishes a conection to the device
+    #
+    # Returns the Connection
+    #
     def connection
       @_connection ||= Airplay::Connection.new(self)
     end
 
+    # Public: Forces the refresh of the connection
+    #
+    # Returns nothing
+    #
     def refresh_connection
       @_connection = nil
     end
 
     private
 
+    # Private: Access the basic info of the device
+    #
+    # Returns a hash with the basic information
+    #
     def basic_info
       @_basic_info ||= begin
         response = connection.get("/server-info").response
@@ -66,6 +110,10 @@ module Airplay
       end
     end
 
+    # Private: Access extra info of the device
+    #
+    # Returns a hash with extra information
+    #
     def extra_info
       @_extra_info ||= begin
         new_device = clone

data/lib/airplay/device/features.rb

@@ -21,7 +21,7 @@ module Airplay
           photo?:                   0 < (hex & ( 1 <<  1 )),
           video_fair_play?:         0 < (hex & ( 1 <<  2 )),
           video_volume_control?:    0 < (hex & ( 1 <<  3 )),
-          video_http_live_streamr?: 0 < (hex & ( 1 <<  4 )),
+          video_http_live_stream?:  0 < (hex & ( 1 <<  4 )),
           slideshow?:               0 < (hex & ( 1 <<  5 )),
           screen?:                  0 < (hex & ( 1 <<  7 )),
           screen_rotate?:           0 < (hex & ( 1 <<  8 )),

data/lib/airplay/devices.rb

@@ -16,25 +16,41 @@ module Airplay
 
     # Public: Finds a device given a name
     #
-    #   device_name - The name of the device
+    # device_name - The name of the device
     #
-    # Returns a Node object
+    # Returns a Device object
     #
     def find_by_name(device_name)
       find_by_block { |device| device if device.name == device_name }
     end
 
+    # Public: Finds a device given an ip
+    #
+    # ip - The ip of the device
+    #
+    # Returns a Device object
+    #
     def find_by_ip(ip)
       find_by_block { |device| device if device.ip == ip }
     end
 
+    # Public: Adds a device to the pool
+    #
+    # name    - The name of the device
+    # address - The address of the device
+    #
+    # Returns nothing
+    #
     def add(name, address)
       self << Device.new(name: name, address: address)
     end
 
     # Public: Adds a device to the list
     #
-    #   value - The Node
+    # value - The Device
+    #
+    # Returns nothing
+    #
     def <<(device)
       return if find_by_ip(device.ip)
       @items << device
@@ -42,6 +58,12 @@ module Airplay
 
     private
 
+    # Private: Finds a devices based on a block
+    #
+    # &block - The block to be executed
+    #
+    # Returns the result of the find on that given block
+    #
     def find_by_block(&block)
       @items.find(&block)
     end

data/lib/airplay/group.rb

@@ -14,15 +14,35 @@ module Airplay
       @name = name
     end
 
+    # Public: Adds a device to the list
+    #
+    # value - The Device
+    #
+    # Returns nothing
+    #
     def <<(device)
       @devices << device
     end
 
+    # Public: Plays a video on all the grouped devices
+    #
+    # file_or_url - The file or url to be sent to the devices
+    # options     - The options to be sent
+    #
+    # Returns a Players instance that syncs the devices
+    #
     def play(file_or_url, options = {})
       @players = @devices.map { |device| device.play(file_or_url, options) }
       Players.new(@players)
     end
 
+    # Public: Views an image on all the grouped devices
+    #
+    # media_or_io - The file or url to be sent to the devices
+    # options     - The options to be sent
+    #
+    # Returns an array of arrays with the result of the playback
+    #
     def view(media_or_io, options = {})
       @devices.map do |device|
         ok = device.view(media_or_io, options)

data/lib/airplay/logger.rb

@@ -11,7 +11,9 @@ module Airplay
 
     # Public: Helper method to be compatible with Net::HTTP
     #
-    #   message - The message to be logged as debug
+    # message - The message to be logged as debug
+    #
+    # Returns nothing
     #
     def <<(message)
       debug message

data/lib/airplay/playable.rb

@@ -2,11 +2,10 @@ require "airplay/player"
 
 module Airplay
   module Playable
-
     # Public: Plays a given video
     #
-    #   file_or_url - The video to be played
-    #   options - Optional start position
+    # file_or_url - The video to be played
+    # options - Optional start position
     #
     # Returns a Player object to control the playback
     #
@@ -15,14 +14,25 @@ module Airplay
       player
     end
 
+    # Public: Gets the current playlist
+    #
+    # Returns the Playlist
+    #
     def playlist
       player.playlist
     end
 
+    # Public: Gets all the playlists
+    #
+    # Returns the Playlists
+    #
     def playlists
       player.playlists
     end
 
+    # Public: Gets the player object
+    #
+    # Returns a Player object
     def player
       @_player ||= Airplay::Player.new(self)
     end

data/lib/airplay/player.rb

@@ -26,10 +26,18 @@ module Airplay
       @device = device
     end
 
+    # Public: Gets all the playlists
+    #
+    # Returns the Playlists
+    #
     def playlists
       @_playlists ||= Hash.new { |h,k| h[k] = Playlist.new(k) }
     end
 
+    # Public: Gets the current playlist
+    #
+    # Returns the first Playlist if none defined or creates a new one
+    #
     def playlist
       @_playlist ||= if playlists.any?
                        key, value = playlists.first
@@ -39,6 +47,12 @@ module Airplay
                      end
     end
 
+    # Public: Sets a given playlist
+    #
+    # name - The name of the playlist to be used
+    #
+    # Returns nothing
+    #
     def use(name)
       @_playlist = playlists[name]
     end
@@ -47,8 +61,10 @@ module Airplay
     #         Creates a new persistent connection to ensure that
     #         the socket will be kept alive
     #
-    #   file_or_url - The url or file to be reproduced
-    #   options - Optional starting time
+    # file_or_url - The url or file to be reproduced
+    # options - Optional starting time
+    #
+    # Returns nothing
     #
     def play(media_to_play = "playlist", options = {})
       start_the_machine
@@ -78,7 +94,9 @@ module Airplay
     # Public: Handles the progress of the playback, the given &block get's
     #         executed every second while the video is played.
     #
-    #   &block - Block to be executed in every playable second.
+    # &block - Block to be executed in every playable second.
+    #
+    # Returns nothing
     #
     def progress(callback)
       timers << every(1) do
@@ -86,12 +104,20 @@ module Airplay
       end
     end
 
+    # Public: Plays the next video in the playlist
+    #
+    # Returns the video that was selected or nil if none
+    #
     def next
       video = playlist.next
       play(video) if video
       video
     end
 
+    # Public: Plays the previous video in the playlist
+    #
+    # Returns the video that was selected or nil if none
+    #
     def previous
       video = playlist.previous
       play(video) if video
@@ -111,7 +137,7 @@ module Airplay
 
     # Public: checks current playback information
     #
-    # Returns a hash with the playback information
+    # Returns a PlaybackInfo object with the playback information
     #
     def info
       response = connection.get("/playback-info").response
@@ -122,18 +148,24 @@ module Airplay
 
     # Public: Resumes a paused video
     #
+    # Returns nothing
+    #
     def resume
       connection.async.post("/rate?value=1")
     end
 
     # Public: Pauses a playing video
     #
+    # Returns nothing
+    #
     def pause
       connection.async.post("/rate?value=0")
     end
 
     # Public: Stops the video
     #
+    # Returns nothing
+    #
     def stop
       connection.post("/stop")
     end
@@ -146,11 +178,17 @@ module Airplay
 
     # Public: Locks the execution until the video gets fully played
     #
+    # Returns nothing
+    #
     def wait
       sleep 1 while wait_for_playback?
       cleanup
     end
 
+    # Public: Cleans up the player
+    #
+    # Returns nothing
+    #
     def cleanup
       timers.cancel
       persistent.close
@@ -158,23 +196,44 @@ module Airplay
 
     private
 
+    # Private: Returns if we have to wait for playback
+    #
+    # Returns a boolean if we need to wait
+    #
     def wait_for_playback?
       return true if playlist.next?
       loading? || playing? || paused?
     end
 
+    # Private: The timers
+    #
+    # Returns a Timers object
+    #
     def timers
       @_timers ||= Timers.new
     end
 
+    # Private: The connection
+    #
+    # Returns the current connection to the device
+    #
     def connection
       @_connection ||= Airplay::Connection.new(@device)
     end
 
+    # Private: The persistent connection
+    #
+    # Returns the persistent connection to the device
+    #
     def persistent
       @_persistent ||= Airplay::Connection.new(@device, keep_alive: true)
     end
 
+    # Private: Starts checking for playback status ever 1 second
+    #          Adds one timer to the pool
+    #
+    # Returns nothing
+    #
     def check_for_playback_status
       timers << every(1) do
         case true
@@ -188,6 +247,8 @@ module Airplay
 
     # Private: Get ready the state machine
     #
+    # Returns nothing
+    #
     def start_the_machine
       @machine = MicroMachine.new(:loading)