airplay 1.0.0.beta3 → 1.0.0

data/lib/airplay/server.rb

@@ -24,6 +24,12 @@ module Airplay
       start!
     end
 
+    # Public: Adds a file to serve
+    #
+    # file - The file path to be served
+    #
+    # Returns the url that the file will have
+    #
     def serve(file)
       sleep 0.1 until running?
       asset_id = App.settings[:assets][file]
@@ -31,12 +37,20 @@ module Airplay
       "http://#{private_ip}:#{@port}/assets/#{asset_id}"
     end
 
+    # Public: Starts the server in a new thread
+    #
+    # Returns nothing
+    #
     def start!
       Thread.start { @server.start }
     end
 
     private
 
+    # Private: Checks the state if the server by attempting a connection to it
+    #
+    # Returns a boolean with the state
+    #
     def running?
       begin
         socket = TCPSocket.new(private_ip, @port)
@@ -47,6 +61,10 @@ module Airplay
       end
     end
 
+    # Private: The local ip of the machine
+    #
+    # Returns the ip address of the current machine
+    #
     def private_ip
       @_ip ||= Socket.ip_address_list.detect do |addr|
         addr.ipv4_private?

data/lib/airplay/version.rb

@@ -1,3 +1,3 @@
 module Airplay
-  VERSION = "1.0.0.beta3"
+  VERSION = "1.0.0"
 end

data/lib/airplay/viewable.rb

@@ -9,6 +9,10 @@ module Airplay
 
     private
 
+    # Private: The Viewer handler
+    #
+    # Returns a Viewer object
+    #
     def viewer
       @_viewer ||= Airplay::Viewer.new(self)
     end

data/lib/airplay/viewer.rb

@@ -13,6 +13,12 @@ module Airplay
 
     # Public: Broadcasts the content to the device
     #
+    # media_or_io - The url, file path or io of the image/s
+    # options     - Options that include the device
+    #               * transition: the type of transition (Default: None)
+    #
+    # Returns if the images was actually sent
+    #
     def view(media_or_io, options = {})
       content = get_content(media_or_io)
       transition = options.fetch(:transition, "None")
@@ -28,17 +34,27 @@ module Airplay
       response.response.status == 200
     end
 
+    # Public: The list of transitions
+    #
+    # Returns the list of trasitions
+    #
     def transitions; TRANSITIONS end
 
     private
 
+    # Public: The connection
+    #
+    # Returns the connection
+    #
     def connection
       @_connection ||= Airplay::Connection.new(@device)
     end
 
     # Private: Gets the content of the possible media_or_io
     #
-    #   media_or_io - The url, file, path or read compatible source
+    # media_or_io - The url, file, path or read compatible source
+    #
+    # Returns the content of the media
     #
     def get_content(media_or_io)
       case true

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: airplay
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - elcuervo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dnssd
@@ -218,21 +218,21 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- SPEC.md
 - airplay-cli.gemspec
 - airplay.gemspec
 - bin/air
 - doc/contributors.md
+- doc/documentation.md
 - doc/header.md
+- doc/img/cli_list.png
+- doc/img/cli_play.png
 - doc/img/logo.png
 - doc/installation.md
 - doc/usage.md
-- examples/demo.rb
-- examples/image.rb
-- examples/video.rb
 - lib/airplay.rb
 - lib/airplay/browser.rb
 - lib/airplay/cli.rb
+- lib/airplay/cli/image_viewer.rb
 - lib/airplay/cli/version.rb
 - lib/airplay/configuration.rb
 - lib/airplay/connection.rb
@@ -278,9 +278,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/SPEC.md

@@ -1,34 +0,0 @@
-# Airplay Spec
-
-## CLI
-
-### Commands
-
-**play**
-**stop**
-**pause**
-
-```bash
-  airplay image.jpg
-  airplay image.jpg --transition slide_left
-
-  airplay video.mp4
-  airplay> pause
-```
-
-## Library
-
-```ruby
-  Airplay.send("image.png", transition: :slide_left)
-
-  player = Airplay.send("video.mp4")
-  player.pause
-  player.rewind("10s")
-
-  Airplay.player
-```
-
-## Documentation
-
-* http://nto.github.com/AirPlay.html
-* http://elcuervo.co/protocol/airplay/apple/2012/01/05/airplay-protocol.html

data/examples/demo.rb

@@ -1,32 +0,0 @@
-require "airplay"
-
-puts Airplay.devices.count
-Airplay.devices.each do |device|
-  puts device.name
-end
-
-videos = [
-  "http://trailers.apple.com/movies/marvel/ironman3/ironman3-tlr1-m4mb0_h1080p.mov",
-  "http://movietrailers.apple.com/movies/dreamworks/needforspeed/needforspeed-tlr1xxzzs2_480p.mov"
-]
-
-apple_tv = Airplay["Apple TV"]
-
-apple_tv.view("./test/fixtures/files/logo.png", transition: "SlideLeft")
-sleep 2
-puts apple_tv.view("./test/fixtures/files/a.png", transition: "SlideLeft")
-sleep 20
-exit
-
-videos.each do |video|
-  player = apple_tv.play(video)
-  sleep 10
-end
-
-Airplay.group["Backyard"] << Airplay["Pool TV"]
-Airplay.group["Backyard"] << Airplay.devices.add("BBQTV", "192.168.1.12")
-
-player = Airplay.group["Backyard"].play("video")
-player.wait
-
-Airplay.all # => Alias for a global group of all the available devices

data/examples/image.rb

@@ -1,9 +0,0 @@
-require "airplay"
-
-Airplay.use "corax", "corax"
-Airplay.configure do |c|
-  c.log_level = "debug"
-end
-
-Airplay.view("http://fitdeck.com/Portals/24254/images/Sunrise.jpg")
-sleep 4

data/examples/video.rb

@@ -1,24 +0,0 @@
-require "airplay"
-
-Airplay.configure do |c|
-#  c.log_level = "debug"
-end
-
-video = "http://trailers.apple.com/movies/marvel/ironman3/ironman3-tlr1-m4mb0_h1080p.mov"
-
-Airplay.play video
-puts "Starts playing: #{video}"
-Airplay.player.progress -> info {
-  if info["rate"]
-    if info["readyToPlay"]
-      total = info["duration"]
-      current = info["position"]
-      percent = (current*100/total).round
-
-      print "\r|#{"=" * percent}> #{percent}%"
-    end
-  end
-}
-
-Airplay.player.wait
-puts "Video playback finished!"