frisky 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2deaa661a30948e0d168faa316a7bb81f089ce59
+  data.tar.gz: 1cec1f6c3430a00632c11dfb9c1e2f1a1a49fc89
+SHA512:
+  metadata.gz: 8715b77ee7c823c6ecad28f0a2110082e8952db901f91cdba1275a59f9fddf8852c5af0dddd35feb49185355a7ef41a0673a3f6d1685981091223b1df987398c
+  data.tar.gz: a39f0325d37d0c95ef0222baa92db352d5d2097baa4a7389467c7e678d7910ea2c699257a2b286de73eab003f0e2096294f1fc849fd0e41636651c8c52564681

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+.bundle
+Gemfile.lock
+
+.autotest
+.DS_Store
+.loadpath
+.project
+.yardoc/
+.bundle/
+.idea/
+
+coverage/
+doc/
+pkg/
+tmp/
+
+*/.DS_Store
+atlassian-ide-plugin.xml

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.3

data/Gemfile

@@ -0,0 +1,23 @@
+# rubocop:disable Style/LeadingCommentSpace
+#ruby-gemset=frisky
+# rubocop:enable Style/LeadingCommentSpace
+source 'http://rubygems.org'
+gemspec
+ruby "2.2.3"
+
+#gem "httpi", '>=2.0.0.rc1'
+#gem 'em-synchrony'
+
+group :development do
+  gem 'coveralls',                    require: false
+  gem 'cucumber',     '>=1.0.0',      require: false
+  gem 'em-websocket', '>=0.3.6'
+  gem 'rake',                         require: false
+  gem 'log_buddy'
+  gem 'rspec',        '>=3.0.0.beta', require: false
+  gem 'simplecov',    '>=0.4.2',      require: false
+  gem 'thin'
+  gem 'thor',         '>=0.1.6',      require: false
+  gem 'yard',         '>=0.7.0',      require: false
+  gem "pry",                          require: false
+end

data/History.md

@@ -0,0 +1,3 @@
+=== 0.1.0.alpha.1
+
+* I do stuffs!

data/LICENSE.md

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2012-2014 Steve Loveless
+Copyright (c) 2015 Jon Frisby
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+# Frisky
+
+* [Homepage](http://github.com/MrJoy/frisky)
+* [UPnP Device Architecture Documentation](http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0.pdf)
+
+
+[<img src="https://travis-ci.org/MrJoy/frisky.png?branch=master" alt="Build Status" />](https://travis-ci.org/MrJoy/frisky) [<img src="https://coveralls.io/repos/MrJoy/frisky/badge.png" alt="Coverage Status" />](https://coveralls.io/r/MrJoy/frisky)
+
+## Description
+
+Ruby's UPnP RubyGem was outdated in Ruby 1.9 when support for Soap4r was
+dropped.  This gem intends to fill that void for Ruby >= 1.9 and allow for
+SSDP search, discovery, advertisement, the ability to act as a UPnP control
+point, as well as provide UPnP devices and services.
+
+This uses [EventMachine](http://github.com/eventmachine/eventmachine), so if
+you're not already, getting familiar with its concepts will be helpful here.
+
+### This Fork
+
+This fork updates the [playful](http://github.com/turboladen/playful) gem,
+which hasn't seen updates in a while.
+
+Specifically:
+
+1. Brings a few dependencies up to date.
+2. Gets rid of unfinished/broken, overly-ambitious functionality.
+
+In short, this fork aims to be a simple, minimal way to run SSDP queries and handle the
+results.
+
+### Er, what's UPnP??
+
+"Universal Plug and Play" is a mashup of network protocols that let network
+devices identify themselves and discover and use each other's services.
+Common implementations of UPnP devices are things like:
+
+* [Media Servers and Clients](http://en.wikipedia.org/wiki/List_of_UPnP_AV_media_servers_and_clients) like...
+    * PS3
+    * Slingbox
+    * Xbox
+    * XBMC
+    * Plex
+    * VLC
+    * Twonky
+    * Mediatomb
+* Home Automation
+    * Philips Hue
+
+
+If you have a device that implements UPnP, you can most likely control it
+programmatically with `frisky`.  You can't today, but eventually you'll be
+able to build your own devices & services with `frisky` that can be consumed
+by other UPnP clients (ex. build a media server with frisky and listen on
+your PS3...).
+
+## Features
+
+### Implemented
+
+* SSDP search, discovery.
+
+
+### Coming
+
+* UPnP Devices & Services (server)
+
+
+## Examples
+
+Take a look at the `tasks` directory; I've created some working examples using
+[Thor](https://github.com/wycats/thor).  You can get a list of these tasks by
+doing `thor -T`.
+
+There's also a more involved, in-progress, working example at
+http://github.com/turboladen/upnp_cp_on_sinatra that uses the Rack middleware
+to build a Sinatra app that allows for controling devices in your network.
+
+### SSDP Searches
+
+An SSDP search simply sends the M-SEARCH out to the multicast group and
+listens for responses for a given (or default of 5 seconds) amount of time.
+The return from this depends on if you're running it within an EventMachine
+reactor or not. If not, it returns is an Array of responses as Hashes, where
+keys are the header names, values are the header values.  Take a look at the
+SSDP.search docs for more on the options here.
+
+```ruby
+require 'frisky/ssdp'
+
+# Search for all devices (do an M-SEARCH with the ST header set to 'ssdp:all')
+all_devices = Frisky::SSDP.search                         # this is default
+all_devices = Frisky::SSDP.search 'ssdp:all'              # or be explicit
+all_devices = Frisky::SSDP.search :all                    # or use short-hand
+
+# Search for root devices (do an M-SEARCH with ST header set to 'upnp:rootdevices')
+root_devices = Frisky::SSDP.search 'upnp:rootdevices'
+root_devices = Frisky::SSDP.search :root                  # or use short-hand
+
+# Search for a device with a specific UUID
+my_device = Frisky::SSDP.search 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d'
+
+# Search for devices of a specific type
+my_media_server = Frisky::SSDP.search 'urn:schemas-upnp-org:device:MediaServer:1'
+
+# All of these searches will return something that looks like
+# => [
+#      {
+#         :control => "max-age=1200",
+#         :date => "Sun, 23 Sep 2012 20:31:48 GMT",
+#         :location => "http://192.168.10.3:5001/description/fetch",
+#         :server => "Linux-i386-2.6.38-15-generic-pae, UPnP/1.0, PMS/1.50.0",
+#         :st => "upnp:rootdevice",
+#         :ext => "",
+#         :usn => "uuid:3c202906-992d-3f0f-b94c-90e1902a136d::upnp:rootdevice",
+#         :length => "0"
+#       }
+#     ]
+```
+
+If you do the search inside of an EventMachine reactor, as the
+Frisky::SSDP::Searcher receives and parses responses, it adds them to the
+accessor #discovery_responses, which is an EventMachine::Channel.  This lets
+you subscribe to the resposnes and do what you want with them as you receive them.
+
+```ruby
+require 'frisky/ssdp'
+
+EM.run do
+  searcher = Frisky::SSDP.search 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d'
+
+  # Create a deferrable object that can be notified when the device we want
+  # has been found and created.
+  device_controller = EventMachine::DefaultDeferrable.new
+
+  # This callback will get called when the device_creator callback is called
+  # (which is called after the device has been created).
+  device_controller.callback do |device|
+    p device.service_list.first.service_type          # "urn:schemas-upnp-org:service:ContentDirectory:1"
+
+    # SOAP actions are converted to Ruby methods--show those
+    p device.service_list.first.singleton_methods     # [:GetSystemUpdateID, :Search, :GetSearchCapabilities, :GetSortCapabilities, :Browse]
+
+    # Call a SOAP method defined in the service.  The response is extracted from the
+    # XML SOAP response and the value is converted from the UPnP dataType to
+    # the related Ruby type.  Reponses are always contained in a Hash, so as
+    # to maintain the relation defined in the service.
+    p device.service_list.first.GetSystemUpdateID     # { :Id => 1 }
+  end
+
+  # Note that you don't have to check for items in the Channel or for when the
+  # Channel is empty: EventMachine will pop objects off the Channel as soon as
+  # they're put there and stop when there are none left.
+  searcher.discovery_responses.pop do |notification|
+    # Do stuff here.
+  end
+end
+```
+
+## Requirements
+
+* Rubies (tested)
+    * 1.9.3
+    * 2.0.0
+    * 2.1.0
+* Gems
+    * eventmachine
+    * em-http-request
+    * em-synchrony
+    * nori
+    * log_switch
+    * savon
+
+
+
+## Install
+
+    $ gem install frisky
+
+## Copyright
+
+Copyright (c) 2015 Jon Frisby
+Copyright (c) 2012-2014 Steve Loveless
+
+See LICENSE.md for details.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+require 'yard'
+
+
+YARD::Rake::YardocTask.new
+Cucumber::Rake::Task.new(:features)
+RSpec::Core::RakeTask.new
+
+# Alias for rubygems-test
+desc "Run all test suites."
+task test: [:spec, :features]
+
+task default: :test
+

data/features/device_discovery.feature

@@ -0,0 +1,9 @@
+Feature: Device discovery
+  As a device controller, I want to be able to discover devices
+  so that I can use the services those devices provide
+
+  Scenario: A single root device
+    Given there's at least 1 root device in my network
+    When I come online
+    Then I should discover at least 1 root device
+    And the location of that device should match my fake device's location

data/features/support/env.rb

@@ -0,0 +1,21 @@
+require 'socket'
+require 'log_buddy'
+require 'cucumber/rspec/doubles'
+require_relative "../../lib/frisky/logger"
+
+def local_ip_and_port
+  orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true
+
+  UDPSocket.open do |s|
+    s.connect '64.233.187.99', 1
+    s.addr.last
+    [s.addr.last, s.addr[1]]
+  end
+ensure
+  Socket.do_not_reverse_lookup = orig
+end
+
+ENV['RUBY_UPNP_ENV'] = 'testing'
+
+Thread.abort_on_exception = true
+Frisky.logging_enabled = false

data/features/support/world_extensions.rb

@@ -0,0 +1,7 @@
+module HelperStuff
+  def local_ip
+    @local_ip ||= local_ip_and_port.first
+  end
+end
+
+World(HelperStuff)

data/frisky.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'frisky/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'frisky'
+  s.version     = Frisky::VERSION
+  s.author      = 'Jon Frisby'
+  s.email       = 'jfrisby@mrjoy.com'
+  s.homepage    = 'http://github.com/MrJoy/frisky'
+  s.summary     = 'Use me to build a UPnP app!'
+  s.description = %q{frisky provides the tools you need to build an app that runs
+in a UPnP environment.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = %w(History.md README.md LICENSE.md)
+  s.require_paths = ['lib']
+  s.required_ruby_version = Gem::Requirement.new('>=1.9.1')
+
+  s.add_dependency 'eventmachine', '>=1.0.0'
+  s.add_dependency 'em-http-request', '>=1.0.2'
+  s.add_dependency 'em-synchrony'
+  s.add_dependency 'nori', '>=2.0.2'
+  s.add_dependency 'log_switch', '~>1.0.0'
+  s.add_dependency 'savon', '~>2.0'
+end

data/lib/core_ext/hash_patch.rb

@@ -0,0 +1,5 @@
+class Hash
+  def symbolize_keys!
+    self.inject({}) { |result, (k, v)| result[k.to_sym] = v; result }
+  end
+end

data/lib/core_ext/socket_patch.rb

@@ -0,0 +1,16 @@
+require 'socket'
+
+# Workaround for missing constants on Windows
+module Socket::Constants
+  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
+  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
+  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
+  IP_TTL            =  4 unless defined? IP_TTL
+end
+
+class Socket
+  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
+  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
+  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
+  IP_TTL            =  4 unless defined? IP_TTL
+end

data/lib/core_ext/to_upnp_s.rb

@@ -0,0 +1,65 @@
+class Hash
+
+  # Converts Hash search targets to SSDP search target String.  Conversions are
+  # as follows:
+  #   uuid: "someUUID"                 # => "uuid:someUUID"
+  #   device_type: "someDeviceType:1"    # => "urn:schemas-upnp-org:device:someDeviceType:1"
+  #   service_type: "someServiceType:2"  # => "urn:schemas-upnp-org:service:someServiceType:2"
+  #
+  # You can use custom UPnP domain names too:
+  #   { device_type: "someDeviceType:3",
+  #   domain_name: "mydomain-com" }    # => "urn:my-domain:device:someDeviceType:3"
+  #   { service_type: "someServiceType:4",
+  #   domain_name: "mydomain-com" }    # => "urn:my-domain:service:someDeviceType:4"
+  #
+  # @return [String] The converted String, according to the UPnP spec.
+  def to_upnp_s
+    if self.has_key? :uuid
+      return "uuid:#{self[:uuid]}"
+    elsif self.has_key? :device_type
+      if self.has_key? :domain_name
+        return "urn:#{self[:domain_name]}:device:#{self[:device_type]}"
+      else
+        return "urn:schemas-upnp-org:device:#{self[:device_type]}"
+      end
+    elsif self.has_key? :service_type
+      if self.has_key? :domain_name
+        return "urn:#{self[:domain_name]}:service:#{self[:service_type]}"
+      else
+        return "urn:schemas-upnp-org:service:#{self[:service_type]}"
+      end
+    else
+      self.to_s
+    end
+  end
+end
+
+
+class Symbol
+
+  # Converts Symbol search targets to SSDP search target String.  Conversions are
+  # as follows:
+  #   :all    # => "ssdp:all"
+  #   :root   # => "upnp:rootdevice"
+  #   "root"  # => "upnp:rootdevice"
+  #
+  # @return [String] The converted String, according to the UPnP spec.
+  def to_upnp_s
+    if self == :all
+      'ssdp:all'
+    elsif self == :root
+      'upnp:rootdevice'
+    else
+      self
+    end
+  end
+end
+
+
+class String
+  # This doesn't do anything to the string; just allows users to call the
+  # method without having to check type first.
+  def to_upnp_s
+    self
+  end
+end