wemote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8691a6386c98200751335860a3601d8377df98a
+  data.tar.gz: c24270bd139e1065b1a7e2e33695629241397bc1
+SHA512:
+  metadata.gz: ae867770e792ab4ab14a25147a94f8f18bd5ebd4297cdce837bc78c41bc286dc20d11dd24267336680001fecddf2822ab8dc03d74f3ab431b8b57d792c65a1e9
+  data.tar.gz: 3f9008db4572c37f11c4fd0a6082e55afae6a827fb82cb6250eb27fb0351a447d464de2424ccadcb9a65a24d2b0c2471449fac515546ab3931f5892f7e19774c

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo
+*~

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - jruby-head

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in manticore.gemspec
+gemspec
+
+gem 'coveralls', require: false
+gem 'manticore', git: 'git://github.com/cheald/manticore.git'
+gem 'rspec'
+gem 'rake'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Kevin Gisi
+
+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,49 @@
+# Wemote [![Build Status](https://travis-ci.org/gisikw/wemote.png)](https://travis-ci.org/gisikw/wemote)[![Coverage Status](https://coveralls.io/repos/gisikw/wemote/badge.png)](https://coveralls.io/r/gisikw/wemote)
+
+Wemote is an interface for controlling WeMo light switches (and possibly outlets in the future). Unlike other implementations, it does not rely upon `playful` for upnp discovery, which makes it compatible with JRuby. For the moment, Wemote leverages Manticore for its HTTP requests, and until that is abstracted, this library is only compatible with JRuby.
+
+## Installation
+
+First, clone the repository:
+
+    git clone https://github.com/gisikw/wemote.git
+
+And then execute:
+
+    $ gem build wemote.gemspec
+
+Finally, run:
+
+    $ gem install wemote-0.0.1.gem
+
+## Usage
+
+You can fetch all lightswitches on your network (providing you've set them up with your smartphone), via:
+
+```ruby
+switches = Wemote::Switch.all(force_reload=false) #=> [#<Remo::Switch:0x27f33aef @host="192.168.1.11", @name="Kitchen Switch", @port="49154">, #<Remo::Switch:0x51a23566 @host="192.168.1.12", @name="Main Room", @port="49154">, #<Remo::Switch:0x705fe568 @host="192.168.1.10", @name="Bathroom Switch", @port="49153">]
+```
+
+Or select a switch by its friendly name:
+
+```ruby
+switch = Wemote::Switch.find('Kitchen Switch') #=> #<Remo::Switch:0x27f33aef @host="192.168.1.11", @name="Kitchen Switch", @port="49154">
+```
+
+Given a Switch instance, you can call the following methods:
+```ruby
+switch.state #=> ["off","on"]
+switch.off? #=> [true,false]
+switch.on? #=> [true,false]
+switch.on!
+switch.off!
+switch.toggle!
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--tty --color --format documentation']
+end
+
+task :default => :spec

data/lib/wemote.rb

@@ -0,0 +1,7 @@
+require 'manticore'
+require_relative './wemote/version'
+
+module Wemote
+  require_relative './wemote/switch'
+  require_relative './wemote/xml'
+end

data/lib/wemote/switch.rb

@@ -0,0 +1,117 @@
+require 'socket'
+require 'ipaddr'
+
+module Wemote
+  class Switch
+    MULTICAST_ADDR = '239.255.255.250'
+    BIND_ADDR = '0.0.0.0'
+    PORT = 1900
+    DISCOVERY= <<-EOF
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: "ssdp:discover"\r
+MX: 10\r
+ST: urn:Belkin:device:lightswitch:1\r
+\r
+EOF
+
+    GET_HEADERS = {
+      "SOAPACTION"   => '"urn:Belkin:service:basicevent:1#GetBinaryState"',
+      "Content-type" => 'text/xml; charset="utf-8"'
+    }
+
+    SET_HEADERS = {
+      "SOAPACTION"   => '"urn:Belkin:service:basicevent:1#SetBinaryState"',
+      "Content-type" => 'text/xml; charset="utf-8"'
+    }
+
+    class << self
+      def all(refresh=false)
+        @switches = nil if refresh
+        @switches ||= fetch_switches
+      end
+
+      def find(name)
+        all.detect{|s|s.name == name}
+      end
+
+      private
+
+      def fetch_switches
+        socket = UDPSocket.new
+        membership = IPAddr.new(MULTICAST_ADDR).hton + IPAddr.new(BIND_ADDR).hton
+
+        socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership)
+        socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, 1)
+        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, 1)
+        socket.bind(BIND_ADDR,PORT)
+
+        switches = []
+
+        3.times { socket.send(DISCOVERY, 0, MULTICAST_ADDR, PORT) }
+
+        sleep 1
+
+        parser = Thread.start do
+          loop do
+            message, _ = socket.recvfrom(1024)
+            if message.match(/LOCATION.*Belkin/m)
+              switches << message.match(/LOCATION:\s+http:\/\/([^\/]+)/)[1].split(':')
+            end
+          end
+        end
+
+        sleep 1
+        parser.kill
+
+        socket.close
+
+        return switches.uniq.map{|s|self.new(*s)}
+
+      end
+    end
+
+    attr_accessor :name
+
+    def initialize(host,port)
+      @host, @port = host, port
+      set_meta
+    end
+
+    def toggle!;  on? ? off! : on!;   end
+    def off!;     set_state(0);       end
+    def off?;     get_state == :off;  end
+    def on!;      set_state(1);       end
+    def on?;      get_state == :on;   end
+
+    def get_state
+      response = begin
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",:body => Wemote::XML.get_binary_state, :headers => GET_HEADERS).call
+      rescue Exception
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",:body => Wemote::XML.get_binary_state, :headers => GET_HEADERS).call
+      end
+      response.body.match(/<BinaryState>(\d)<\/BinaryState>/)[1] == '1' ? :on : :off
+    end
+
+    def set_state(state)
+      begin
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",:body => Wemote::XML.set_binary_state(state), :headers => SET_HEADERS).call
+      rescue Exception
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",:body => Wemote::XML.set_binary_state(state), :headers => SET_HEADERS).call
+      end
+    end
+
+    private
+
+    def client
+      @client ||= Manticore::Client.new
+    end
+
+    def set_meta
+      client.get("http://#{@host}:#{@port}/setup.xml") do |response|
+        @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
+      end
+    end
+
+  end
+end

data/lib/wemote/version.rb

@@ -0,0 +1,3 @@
+module Wemote
+  VERSION = "0.1.0"
+end

data/lib/wemote/xml.rb

@@ -0,0 +1,22 @@
+module Wemote
+  module XML
+    class << self
+      TEMPLATES = {}
+
+      Dir.glob(File.join(File.dirname(__FILE__),'/../../xml/*.xml')).each do |file|
+        basename = File.basename(file,'.xml')
+        TEMPLATES[basename] = File.read(file)
+
+        define_method basename do |*args|
+          t = TEMPLATES[basename].dup
+          if (replace = t.scan(/{{\d+}}/).size) != args.size
+            raise ArgumentError, "wrong number of arguments calling `#{basename}` (#{args.size} for #{replace})"
+          end
+          (1..replace).map{|i|t.gsub!("{{#{i}}}",args[i-1].to_s)}
+          t
+        end
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'wemote'
+require 'coveralls'
+
+Coveralls.wear!

data/spec/wemote/switch_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe Wemote::Switch do
+  describe 'class methods' do
+
+    describe '.all' do
+      it 'should have specs'
+    end
+
+    describe '.find' do
+      it 'should return an instance whose name matches the argument' do
+        client = Manticore::Client.new
+        client.stub('http://fakehost:1234/setup.xml',body:'<friendlyName>Test Switch</friendlyName>',code:200)
+        Wemote::Switch.any_instance.stub(:client).and_return(client)
+        switch = Wemote::Switch.new('fakehost','1234')
+        Wemote::Switch.instance_variable_set(:@switches,[switch])
+        Wemote::Switch.find('Test Switch').should == switch
+      end
+    end
+
+  end
+
+  describe 'instance methods' do
+    before do
+      client = Manticore::Client.new
+      client.stub('http://fakehost:1234/setup.xml',body:'<friendlyName>Test Switch</friendlyName>',code:200)
+      Wemote::Switch.any_instance.stub(:client).and_return(client)
+      @switch = Wemote::Switch.new('fakehost','1234')
+    end
+
+    describe '#initialize' do
+      it 'should set the host and port from the arguments' do
+        @switch.instance_variable_get(:@host).should == 'fakehost'
+        @switch.instance_variable_get(:@port).should == '1234'
+      end
+
+      it 'should set the friendly name of the switch' do
+        @switch.name.should == 'Test Switch'
+      end
+
+    end
+
+    describe 'on!' do
+      it 'should call #set_state with an argument of 1' do
+        expect(@switch).to receive(:set_state).with(1)
+        @switch.on!
+      end
+    end
+
+    describe 'off!' do
+      it 'should call #set_state with an argument of 0' do
+        expect(@switch).to receive(:set_state).with(0)
+        @switch.off!
+      end
+    end
+
+    describe 'on?' do
+      it 'should return whether the switch state is on' do
+        @switch.stub(:get_state).and_return(:on)
+        @switch.on?.should == true
+        @switch.stub(:get_state).and_return(:off)
+        @switch.on?.should == false
+      end
+    end
+
+    describe 'off?' do
+      it 'should return whether the switch state is off' do
+        @switch.stub(:get_state).and_return(:on)
+        @switch.off?.should == false
+        @switch.stub(:get_state).and_return(:off)
+        @switch.off?.should == true
+      end
+    end
+
+    describe 'get_state' do
+      it 'should return the binary state of the switch' do
+        @switch.client.stub('http://fakehost:1234/upnp/control/basicevent1',body:'<BinaryState>1</BinaryState>',code:200)
+        @switch.get_state.should == :on
+        @switch.client.stub('http://fakehost:1234/upnp/control/basicevent1',body:'<BinaryState>0</BinaryState>',code:200)
+        @switch.get_state.should == :off
+      end
+    end
+
+    describe 'set_state' do
+      it 'should set the binary state of the switch' do
+        @switch.client.stub('http://fakehost:1234/upnp/control/basicevent1',body:'Called',code:200)
+        @switch.set_state(1).body.should == 'Called'
+      end
+    end
+
+  end
+end

data/wemote.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wemote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wemote"
+  spec.version       = Wemote::VERSION
+  spec.authors       = ["Kevin Gisi"]
+  spec.email         = ["kevin@kevingisi.com"]
+  spec.description   = %q{Wemote is a JRuby-friendly API for Wemo light switches}
+  spec.summary       = %q{Wemote is a JRuby-friendly API for Wemo light switches}
+  spec.homepage      = "https://github.com/gisikw/wemote"
+  spec.license       = "MIT"
+  spec.platform      = 'ruby'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "manticore", "~> 0.2.1"
+end

data/xml/get_binary_state.xml

@@ -0,0 +1,7 @@
+<?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:GetBinaryState xmlns:u="urn:Belkin:service:basicevent:1"/>
+  </s:Body>
+</s:Envelope>

data/xml/set_binary_state.xml

@@ -0,0 +1,9 @@
+<?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>{{1}}</BinaryState>
+     </u:SetBinaryState>
+  </s:Body>
+</s:Envelope>

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: wemote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Gisi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: manticore
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  prerelease: false
+  type: :runtime
+description: Wemote is a JRuby-friendly API for Wemo light switches
+email:
+- kevin@kevingisi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wemote.rb
+- lib/wemote/switch.rb
+- lib/wemote/version.rb
+- lib/wemote/xml.rb
+- spec/spec_helper.rb
+- spec/wemote/switch_spec.rb
+- wemote.gemspec
+- xml/get_binary_state.xml
+- xml/set_binary_state.xml
+homepage: https://github.com/gisikw/wemote
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key:
+specification_version: 4
+summary: Wemote is a JRuby-friendly API for Wemo light switches
+test_files:
+- spec/spec_helper.rb
+- spec/wemote/switch_spec.rb