wemo_device 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2eae8671c6fab15a08feecb55a6164f611231f3cdeede64cfb5868709511342a
+  data.tar.gz: 41801313e816335bf167ef830bd9c58d965edba0202af2e4f736dedd90740706
+SHA512:
+  metadata.gz: 6a0e2da82c6570f8a7773f6b4c011509f17edc4ef5c687d7e896e2e99d6640162c1caf1879ce056b0a94535fb024a78bc6aeb69b72a26a6c317d900c2c020975
+  data.tar.gz: f4672d0150edea516f3a924f7a608fbadd5cfbab4739974658467fc5e335a23d523c980d4619b8343fb02969e62b86dbdae54c3f99cc8a9b127c8ea7148b8b55

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Yoshimasa Niwa
+
+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,50 @@
+wemo_device
+===========
+
+NAME
+----
+
+`wemo_device` -- A simple Ruby gem library that lookups [Blkin](http://www.belkin.com/)’s [Wemo](http://www.wemo.com/) devices.
+
+DESCRIPTION
+-----------
+
+`wemo_device` is a Ruby gem library that provides a set of interfaces that looks up Wemo devices by using SSDP protocol, which is a part of UPnP protocols.
+
+Since Wemo devices are using SSDP, but its implementation is for their propriety usage, it does not fully conform the specifications.
+
+This library wraps these behaviors and provides a simple interface to lookup the devices on the network.
+
+This library does not have any extra dependencies, works perfect with Ruby standard libraries.
+
+USAGE
+-----
+
+Recommend to use [Bundler](https://bundler.io/) to add `wemo_device` as a dependency to your project. Add next line in `Gemfile`.
+
+    gem "wemo_device"
+
+`wemo_device` provides a simple API to lookup. To list up all devices on the network, use next code.
+
+    require "rubygems"
+    require "wemo_device"
+    require "pp"
+    
+    WemoDevice::Device.lookup.each do |device|
+      pp device
+    end
+
+EXAMPLES
+--------
+
+In the `examples` directory, there are a few examples how to use this library.
+
+ * `lookup.rb`
+
+    Lookup all Wemo devices on the network.
+
+ * `switch.rb`
+
+    Turn on and off the Wemo switch.
+    Set unique service name found by `lookup.rb` in form of `--usn uuid:....` argument,
+    and use `--on` or `--off` to toggle the Wemo switch.

data/examples/lookup.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "wemo_device"
+require "pp"
+
+WemoDevice::Device.lookup.each do |device|
+  pp device
+end

data/examples/switch.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "wemo_device"
+require "optparse"
+
+def set_wemo_switch_state(unique_service_name, state)
+  device = WemoDevice::Device.lookup.find do |device|
+    device.unique_service_name == unique_service_name
+  end
+  return false unless device
+
+  uri = URI.parse(device.location)
+  header = {
+    "SOAPACTION" => '"urn:Belkin:service:basicevent:1#SetBinaryState"',
+    "Content-Type" => "text/xml"
+  }
+  payload = <<-END_OF_XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+    <s:Body>
+    <u:SetBinaryState xmlns:u="urn:Belkin:service:basicevent:1">
+    <BinaryState>#{state ? 1 : 0}</BinaryState>
+    </u:SetBinaryState>
+    </s:Body>
+    </s:Envelope>
+  END_OF_XML
+
+  Net::HTTP.start(uri.host, uri.port) do |http|
+    case http.post("/upnp/control/basicevent1", payload, header)
+    when Net::HTTPOK
+      return true
+    else
+      return false
+    end
+  end
+end
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.on_tail("-u", "--usn=USN", "Wemo Switch unique service name") do |usn|
+    options[:usn] = usn
+  end
+  opts.on_tail("--on", "Turn on the switch") do
+    options[:action] = :on
+  end
+  opts.on_tail("--off", "Turn off the switch") do
+    options[:action] = :off
+  end
+end
+option_parser.parse!(ARGV)
+
+raise "Missing unique service name" unless options[:usn]
+
+case options[:action]
+when :on
+  set_wemo_switch_state(options[:usn], true)
+when :off
+  set_wemo_switch_state(options[:usn], false)
+else
+  raise "Missing action"
+end

data/lib/wemo_device.rb

@@ -0,0 +1,5 @@
+module WemoDevice
+  autoload :SSDP, "wemo_device/ssdp.rb"
+  autoload :Device, "wemo_device/device.rb"
+  autoload :Description, "wemo_device/description.rb"
+end

data/lib/wemo_device/device.rb

@@ -0,0 +1,36 @@
+require "rexml/document"
+
+module WemoDevice
+  URN = "urn:Belkin:service:basicevent:1".freeze
+
+  class Device
+    class << self
+      def lookup
+        # Wemo devices are responding only when search target is the URN.
+        # `ssdp:all` and other search target doesn't work.
+        SSDP.new.lookup(URN, 3).select do |response|
+          # There are many devices that ignores `ST`, like Philips Hue.
+          response.search_target == URN
+        end.map do |response|
+          Device.new(response)
+        end
+      end
+    end
+
+    def initialize(response)
+      @response = response
+    end
+
+    def unique_service_name
+      @response.unique_service_name
+    end
+
+    def location
+      @response.location
+    end
+
+    def description
+      @description ||= Description.new(@response.location)
+    end
+  end
+end

data/lib/wemo_device/ssdp.rb

@@ -0,0 +1,82 @@
+require "socket"
+require "timeout"
+require "net/http"
+
+module WemoDevice
+  class SSDP
+    MULTICAST_HOST = "239.255.255.250".freeze
+    MULTICAST_PORT = 1900.freeze
+
+    class Response
+      def initialize(host, port, payload)
+        @host = host
+        @port = port
+        @payload = payload
+      end
+
+      def search_target
+        http_response["st"]
+      end
+
+      def unique_service_name
+        http_response["usn"]
+      end
+
+      def location
+        http_response["location"]
+      end
+
+      private
+
+      def http_response
+        @http_response ||= parse_http_response
+      end
+
+      def parse_http_response
+        # Using Net::HTTPResponse private API to parse HTTP body from String.
+        # See `net/http.rb`, `net/protocol.rb`, and `net/http/response.rb`.
+        string_io = StringIO.new(@payload)
+        buffered_io = Net::BufferedIO.new(string_io)
+        Net::HTTPResponse.read_new(buffered_io)
+      end
+    end
+
+    def lookup(search_target, timeout)
+      UDPSocket.open do |socket|
+        # `sendto(2)` should automatically `bind(2)`.
+        socket.send(m_search_message(search_target), 0, MULTICAST_HOST, MULTICAST_PORT)
+
+        responses = []
+        begin
+          Timeout.timeout(timeout) do
+            loop do
+              # `recv(2)` may discard excess bytes for message based sockets such as `SOCK_DGRAM`
+              # when a message is too long and not fir in the given length and `MSG_PEEK` is not set.
+              # Thus, the entire message shall be read in a single operation.
+              payload, (_, port, host, _) = socket.recvfrom(4096)
+              responses << Response.new(host, port, payload)
+            end
+          end
+        rescue Timeout::Error
+        end
+
+        responses
+      end
+    end
+
+    def m_search_message(search_target)
+      [
+        "M-SEARCH * HTTP/1.1",
+        "Content-Length: 0",
+        "ST: #{search_target}",
+        # Device responses should be delayed a random duration between 0 and this many seconds
+        # to balance load for the control point when it processes responses.
+        "MX: 2",
+        "MAN: \"ssdp:discover\"",
+        "HOST: #{MULTICAST_HOST}:#{MULTICAST_PORT}",
+        "",
+        ""
+      ].join("\r\n")
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: wemo_device
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshimasa Niwa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate Sparkle appcast.xml
+email:
+- niw@niw.at
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- examples/lookup.rb
+- examples/switch.rb
+- lib/wemo_device.rb
+- lib/wemo_device/device.rb
+- lib/wemo_device/ssdp.rb
+homepage: https://github.com/niw/wemo_device
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/niw/wemo_device
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Generate Sparkle appcast.xml
+test_files: []