airplay 1.0.0.beta3 → 1.0.0

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 rvm:
   - "1.9.3"
   - "2.0.0"
-  - "rbx-19mode"
 before_install:
   - "sudo apt-get -qq update"
   - "sudo apt-get -qq install rdnssd libavahi-compat-libdnssd-dev"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    airplay (1.0.0.beta3)
+    airplay (1.0.0)
       CFPropertyList (~> 2.2.0)
       celluloid (~> 0.15.0)
       cuba (~> 3.1.0)

data/README.md

@@ -24,11 +24,11 @@ much as you want in: https://gumroad.com/l/airplay
 
 ### Library
 
-`gem install airplay --pre`
+`gem install airplay`
 
 ## CLI
 
-`gem install airplay-cli --pre`
+`gem install airplay-cli`
 
 ## Usage
 
@@ -37,6 +37,9 @@ much as you want in: https://gumroad.com/l/airplay
 #### View devices
 
 `air list`
+
+![air list](doc/img/cli_list.png)
+
 ```text
 * Apple TV (AppleTV2,1 running 11A502)
   ip: 192.168.1.12
@@ -46,6 +49,9 @@ much as you want in: https://gumroad.com/l/airplay
 #### Play a video
 
 `air play [url to video or local file]`
+
+![air play](doc/img/cli_play.png)
+
 ```text
 Playing http://movietrailers.apple.com/movies/universal/rush/rush-tlr3_480p.mov?width=848&height=352
 Time: 00:00:13 [=====                                              ] 7% Apple TV
@@ -63,8 +69,8 @@ Time: 00:00:13 [=====                                              ] 7% Apple TV
 Airplay.configure do |config|
   config.log_level      # Log4r levels (Default: Log4r::ERROR)
   config.autodiscover   # Allows to search for nodes (Default: true)
-  config.host           # In which host bind the server (Default: 0.0.0.0)
-  config.port           # In which port bind the server (Default: 1337)
+  config.host           # In which host to bind the server (Default: 0.0.0.0)
+  config.port           # In which port to bind the server (Default: 1337)
   config.output         # Where to log (Default: Log4r::Outputter.stdout)
 end
 ```
@@ -77,11 +83,15 @@ require "airplay"
 Airplay.devices.each do |device|
   puts device.name
 end
+```
 
-# You can access an know device easily
+#### Accesing and Grouping
+
+```ruby
+# You can access a known device easily
 device = Airplay["Apple TV"]
 
-# Or you can group known devices to have them do a given action toghether
+# Or you can group known devices to have them do a given action together
 Airplay.group["Backyard"] << Airplay["Apple TV"]
 Airplay.group["Backyard"] << Airplay["Room TV"]
 
@@ -165,8 +175,14 @@ player.progress -> progress {
 }
 ```
 
+## Documentation
+
+All the documentation of the README can be found in the `doc` folder.
+To generate an updated README based on the contents of `doc` please use `rake doc:generate`
+
 ## Contributors
 
 * [sodabrew](http://github.com/sodabrew)
 * [pote](http://github.com/pote)
-
+* [janogonzalez](http://github.com/janogonzalez) - Who allowed me to release 1.0
+  from startech conf <3

data/Rakefile

@@ -84,7 +84,7 @@ task :test => [:spec]
 
 namespace :doc do
   task :generate do
-    structure = %w(header installation usage contributors)
+    structure = %w(header installation usage documentation contributors)
 
     File.open("README.md", "w+") do |f|
       structure.each { |part| f << File.read("doc/#{part}.md") + "\n" }

data/airplay-cli.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.homepage     = "http://github.com/elcuervo/airplay"
   s.files        = %w(bin/air lib/airplay/cli.rb)
 
-  s.add_dependency("airplay",              "=  1.0.0.beta3")
+  s.add_dependency("airplay",              "=  1.0.0")
   s.add_dependency("clap",                 "~> 1.0.0")
   s.add_dependency("ruby-progressbar",     "~> 1.2.0")
 end

data/bin/air

@@ -2,26 +2,36 @@
 
 require "clap"
 require "airplay/cli"
+require "airplay/cli/version"
 
-Clap.run ARGV,
-  "--device"      => lambda { |device_name| @device = Airplay[device_name] },
-  "--wait"        => lambda { |sec| @wait = sec.to_i },
-  "--interactive" => lambda { @interactive = true },
+begin
+  Clap.run ARGV,
+    "--device"      => lambda { |device_name| @device = Airplay[device_name] },
+    "--wait"        => lambda { |sec| @wait = sec.to_i },
+    "--interactive" => lambda { @interactive = true },
 
-  "list" => Airplay::CLI.method(:list),
+    "list" => Airplay::CLI.method(:list),
 
-  "play" => lambda { |video|
-    options = { device: @device || Airplay.devices.first }
-    Airplay::CLI.play(video, options)
-  },
+    "version" => lambda { puts Airplay::CLI::VERSION },
 
-  "view" => lambda { |file|
-    options = {
-      device: @device || Airplay.devices.first,
-      interactive: @interactive || false,
-      wait: @wait || 3
+    "play" => lambda { |video|
+      options = { device: @device || Airplay.devices.first }
+      Airplay::CLI.play(video, options)
+    },
+
+    "view" => lambda { |file|
+      options = {
+        device: @device || Airplay.devices.first,
+        interactive: @interactive || false,
+        wait: @wait || 3
+      }
+      Airplay::CLI.view(file, options)
     }
-    Airplay::CLI.view(file, options)
-  }
+
+rescue Airplay::Browser::NoDevicesFound
+  puts "No devices found."
+rescue Interrupt
+  puts "Bye!"
+end
 
 # vim: ft=ruby

data/doc/documentation.md

@@ -0,0 +1,4 @@
+## Documentation
+
+All the documentation of the README can be found in the `doc` folder.
+To generate an updated README based on the contents of `doc` please use `rake doc:generate`

data/doc/usage.md

@@ -5,6 +5,9 @@
 #### View devices
 
 `air list`
+
+![air list](doc/img/cli_list.png)
+
 ```text
 * Apple TV (AppleTV2,1 running 11A502)
   ip: 192.168.1.12
@@ -14,6 +17,9 @@
 #### Play a video
 
 `air play [url to video or local file]`
+
+![air play](doc/img/cli_play.png)
+
 ```text
 Playing http://movietrailers.apple.com/movies/universal/rush/rush-tlr3_480p.mov?width=848&height=352
 Time: 00:00:13 [=====                                              ] 7% Apple TV
@@ -31,8 +37,8 @@ Time: 00:00:13 [=====                                              ] 7% Apple TV
 Airplay.configure do |config|
   config.log_level      # Log4r levels (Default: Log4r::ERROR)
   config.autodiscover   # Allows to search for nodes (Default: true)
-  config.host           # In which host bind the server (Default: 0.0.0.0)
-  config.port           # In which port bind the server (Default: 1337)
+  config.host           # In which host to bind the server (Default: 0.0.0.0)
+  config.port           # In which port to bind the server (Default: 1337)
   config.output         # Where to log (Default: Log4r::Outputter.stdout)
 end
 ```
@@ -45,11 +51,15 @@ require "airplay"
 Airplay.devices.each do |device|
   puts device.name
 end
+```
+
+#### Accesing and Grouping
 
-# You can access an know device easily
+```ruby
+# You can access a known device easily
 device = Airplay["Apple TV"]
 
-# Or you can group known devices to have them do a given action toghether
+# Or you can group known devices to have them do a given action together
 Airplay.group["Backyard"] << Airplay["Apple TV"]
 Airplay.group["Backyard"] << Airplay["Room TV"]
 

data/lib/airplay.rb

@@ -8,22 +8,44 @@ require "airplay/version"
 #
 module Airplay
   class << self
+    # Public: General configuration
+    #
+    # &block - The block that will modify the configuration
+    #
+    # Returns the configuration file.
+    #
     def configure(&block)
       yield(configuration) if block
     end
 
+    # Public: Access the server object
+    #
+    # Returns the Server object
+    #
     def server
       @_server ||= Server.new
     end
 
+    # Public: Browses for devices in the current network
+    #
+    # Returns nothing.
+    #
     def browse
       browser.browse
     end
 
+    # Public: Access or create a group based on a key
+    #
+    # Returns the Hash object.
+    #
     def group
       @_group ||= Hash.new { |h, k| h[k] = Group.new(k) }
     end
 
+    # Public: Helper method to access all the devices
+    #
+    # Returns a Group with all the devices.
+    #
     def all
       @_all ||= begin
         group = Group.new(:all)
@@ -32,23 +54,39 @@ module Airplay
       end
     end
 
-    # Public: Lists found devices
+    # Public: Lists found devices if autodiscover is enabled
+    #
+    # Returns an Array with all the devices
     #
     def devices
       browse if browser.devices.empty? && configuration.autodiscover
       browser.devices
     end
 
+    # Public: Access the configuration object
+    #
+    # Returns the Configuration object
+    #
     def configuration
       @_configuration ||= Configuration.new
     end
 
+    # Public: Access a device by name
+    #
+    # device_name - The name to search on the devices
+    #
+    # Returns the found device
+    #
     def [](device_name)
       devices.find_by_name(device_name)
     end
 
     private
 
+    # Private: Access the browser object
+    #
+    # Returns the momoized Browser object
+    #
     def browser
       @_browser ||= Browser.new
     end

data/lib/airplay/browser.rb

@@ -8,6 +8,8 @@ module Airplay
   # Public: Browser class to find Airplay-enabled devices in the network
   #
   class Browser
+    NoDevicesFound = Class.new(StandardError)
+
     SEARCH = "_airplay._tcp."
 
     def initialize
@@ -16,6 +18,8 @@ module Airplay
 
     # Public: Browses in the search of devices and adds them to the nodes
     #
+    # Returns nothing or raises NoDevicesFound if there are no devices
+    #
     def browse
       timeout(5) do
         DNSSD.browse!(SEARCH) do |node|
@@ -23,10 +27,14 @@ module Airplay
           break unless node.flags.more_coming?
         end
       end
+    rescue Timeout::Error => e
+      raise NoDevicesFound
     end
 
     # Public: Access to the node list
     #
+    # Returns the Devices list object
+    #
     def devices
       @_devices ||= Devices.new
     end
@@ -35,8 +43,8 @@ module Airplay
 
     # Private: Resolves a node given a node and a resolver
     #
-    #   node - The given node
-    #   resolver - The DNSSD::Server that is resolving nodes
+    # node - The given node
+    # resolver - The DNSSD::Server that is resolving nodes
     #
     # Returns if there are more nodes coming
     #
@@ -56,7 +64,9 @@ module Airplay
 
     # Private: Resolves the node information given a node
     #
-    #   node - The node from the DNSSD browsing
+    # node - The node from the DNSSD browsing
+    #
+    # Returns nothing
     #
     def resolve(node)
       resolver = DNSSD::Service.new

data/lib/airplay/cli.rb

@@ -1,9 +1,18 @@
-require "airplay"
 require "ruby-progressbar"
+require "airplay"
+require "airplay/cli/image_viewer"
 
+# Public: Airplay core module
+#
 module Airplay
+  # Public: Airplay CLI module
+  #
   module CLI
     class << self
+      # Public: Lists all the devices to STDOUT
+      #
+      # Returns nothing.
+      #
       def list
         Airplay.devices.each do |device|
           puts <<-EOS.gsub(/^\s{12}/,'')
@@ -15,6 +24,14 @@ module Airplay
         end
       end
 
+      # Public: Plays a video given a device
+      #
+      # video   - The url or file path to the video
+      # options - Options that include the device
+      #           * device: The device in which it should run
+      #
+      # Returns nothing.
+      #
       def play(video, options)
         device = options[:device]
         player = device.play(video)
@@ -31,74 +48,34 @@ module Airplay
         player.wait
       end
 
+      # Public: Show an image given a device
+      #
+      # file_or_dir - The url, file path or folder path to the image/s
+      # options     - Options that include the device
+      #               * device: The device in which it should run
+      #               * interactive: Boolean flag to control playback with the
+      #                              arrow keys
+      #
+      # Returns nothing.
+      #
       def view(file_or_dir, options)
         device = options[:device]
-        wait = options[:wait]
+        viewer = ImageViewer.new(device, options)
 
         if File.directory?(file_or_dir)
           files = Dir.glob("#{file_or_dir}/*")
 
           if options[:interactive]
-            view_interactive(files)
+            viewer.interactive(files)
           else
-            view_slideshow(files)
+            viewer.slideshow(files)
           end
         else
-          view_image(device, file_or_dir)
+          viewer.view(file_or_dir)
           sleep
         end
       end
 
-      private
-
-      def view_interactive(files)
-        numbers = Array(0...files.count)
-        transition = "None"
-
-        i = 0
-        loop do
-          view_image(device, files[i], transition)
-
-          case read_char
-            # Right Arrow
-          when "\e[C"
-            i = i + 1 > numbers.count - 1 ? 0 : i + 1
-            transition = "SlideLeft"
-          when "\e[D"
-            i = i - 1 < 0 ? numbers.count - 1 : i - 1
-            transition = "SlideRight"
-          else
-            break
-          end
-        end
-      end
-
-      def view_slideshow(files)
-        files.each do |file|
-          view_image(device, file)
-          sleep wait
-        end
-      end
-
-      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
-
-      def view_image(device, image, transition = "SlideLeft")
-        device.view(image, transition: transition)
-      end
     end
   end
 end