wemote 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b18903132febc3de01e2796ce0b7adde752b030f
-  data.tar.gz: 07503eba981f501449f2b6f86afb90baca0ad7c7
+  metadata.gz: 88d7829f2bfa8a7892103c87c14696a2efcafcf0
+  data.tar.gz: 8b7e761fbfde70ab48e0ca55cdd50c388c51a9c6
 SHA512:
-  metadata.gz: 3313aa5e43f3394d505f9a2b6c7dbfe06dc6f49effaaea8b86e43542e93f5cb4583793631b34cd6fac99be1aa3440e4ca3b9b40320a8d4ba36fea52418e1662a
-  data.tar.gz: ad62e4b4497c8509246861e52479b677ce495d1859103fbd67823552af6b92f346ad7972cd1dbc8f54e1b7129aa52429172691be75eb2331e639bd09e879b237
+  metadata.gz: f7c758531b285a15f3fa50b0eadf8aae1c56ae746b73909789efa795d08414ca1b5f47f8af8fff56aefb48ac9ccd99c0a8d1844dedc4eb1b53a3e9569f84af12
+  data.tar.gz: a9ca631f0509ef3a4d8cab76a1e229b1507a003ccfb62f0e8261ea6669be7ff4799e89944732bc1698394a19b7e6f0e9c1d3f70ac8c9dbb04eb95505472acb06

data/Gemfile

@@ -4,7 +4,6 @@ gemspec
 # Commented out until I can determine a way to set engine-specific dependencies
 # gem 'manticore', git: 'git://github.com/cheald/manticore.git'
 #gem 'typhoeus'
-gem 'coveralls', :require => false
 gem 'httparty'
 gem 'rspec'
 gem 'rake'

data/README.md

@@ -1,4 +1,4 @@
-# Wemote [![Build Status](https://travis-ci.org/gisikw/wemote.png)](https://travis-ci.org/gisikw/wemote) [![Gem Version](https://badge.fury.io/rb/wemote.png)](http://badge.fury.io/rb/wemote) [![Coverage Status](https://coveralls.io/repos/gisikw/wemote/badge.png)](https://coveralls.io/r/gisikw/wemote) [![Code Climate](https://codeclimate.com/github/gisikw/wemote.png)](https://codeclimate.com/github/gisikw/wemote)
+# Wemote [![Build Status](https://travis-ci.org/gisikw/wemote.png)](https://travis-ci.org/gisikw/wemote) [![Gem Version](https://badge.fury.io/rb/wemote.png)](http://badge.fury.io/rb/wemote) [![Code Climate](https://codeclimate.com/github/gisikw/wemote.png)](https://codeclimate.com/github/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 alternative Ruby engines, such as JRuby.
 
@@ -21,18 +21,17 @@ Or install it yourself as:
 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">]
+switches = Wemote::Switch.all #=> [#<Wemote::Switch:0x27f33aef @host="192.168.1.11", @name="Kitchen Switch", @port="49154">
 ```
 
 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">
+switch = Wemote::Switch.find('Kitchen Switch') #=> #<Wemote::Switch:0x27f33aef @host="192.168.1.11", @name="Kitchen Switch", @port="49154">
 ```
 
 Given a Switch instance, you can call the following methods:
 ```ruby
-switch.get_state #=> [:off,:on]
 switch.off? #=> [true,false]
 switch.on? #=> [true,false]
 switch.on!
@@ -42,7 +41,7 @@ switch.toggle!
 
 ## Performance
 
-Wemote is designed to be performant - and as such, it will leverage the best HTTP library available for making requests. Currently, Wemote will use (in order of preference): `manticore`, `typhoeus`, `httparty`, and finally (miserably) `net/http`. Because you probably like things fast too, we recommend you `gem install manticore` on JRuby, or `gem install typhoeus` on another engine. In order to keep the gem as flexible as possible, none of these are direct dependencies. They just make Wemote happy and fast.
+Wemote is designed to be performant - and as such, it will leverage the best HTTP library available for making requests. Currently, Wemote will use (in order of preference): `manticore`, `typhoeus`, and finally (miserably) `net/http`. Because you probably like things fast too, we recommend you `gem install manticore` on JRuby, or `gem install typhoeus` on another engine. In order to keep the gem as flexible as possible, none of these are direct dependencies. They just make Wemote happy and fast.
 
 ## Contributing
 

data/lib/wemote.rb

@@ -1,7 +1,16 @@
 require_relative './wemote/version'
 
 module Wemote
+  require_relative './wemote/collection/switch'
   require_relative './wemote/switch'
   require_relative './wemote/client'
   require_relative './wemote/xml'
+
+  class << self
+
+    def discover(broadcast='255.255.255.255')
+      Wemote::Switch.send(:discover,broadcast)
+    end
+
+  end
 end

data/lib/wemote/client.rb

@@ -6,6 +6,7 @@ module Wemote
         constants.collect {|const_name| const_get(const_name)}.select {|const| const.class == Module}.detect do |mod|
           fulfilled = false
           begin
+            next unless mod.const_defined?(:DEPENDENCIES)
             mod.const_get(:DEPENDENCIES).map{|d|require d}
             fulfilled = true
           rescue LoadError
@@ -15,63 +16,59 @@ module Wemote
       end
     end
 
-    module Manticore
-      DEPENDENCIES = ['manticore']
-
-      def get(*args)
-        _get(::Manticore,*args).call
+    module SmartLib
+      %w{get post put}.each do |name|
+        define_method name do |*args|
+          _req(@lib,name,*args).tap{|r|r.call if @call}
+        end
       end
+    end
 
-      def post(*args)
-        _post(::Manticore,*args).call
+    module Manticore
+      DEPENDENCIES = ['manticore']
+      def self.extended(base)
+        base.instance_variable_set(:@lib,::Manticore)
+        base.instance_variable_set(:@call,true)
+        base.extend(SmartLib)
       end
-
     end
 
     module Typhoeus
       DEPENDENCIES = ['typhoeus']
-
-      def get(*args)
-        _get(::Typhoeus,*args)
-      end
-
-      def post(*args)
-        _post(::Typhoeus,*args)
+      def self.extended(base)
+        base.instance_variable_set(:@lib,::Typhoeus)
+        base.extend(SmartLib)
       end
-
     end
 
-    module HTTParty
-      DEPENDENCIES = ['httparty']
-
-      def get(*args)
-        _get(::HTTParty,*args)
-      end
+    # HTTParty is temporarily disabled, as it's auto-parsing the XML
 
-      def post(*args)
-        _post(::HTTParty,*args)
-      end
-    end
+    #module HTTParty
+    #  DEPENDENCIES = ['httparty']
+    #  def self.extended(base)
+    #    base.instance_variable_set(:@lib,::HTTParty)
+    #    base.extend(SmartLib)
+    #  end
+    #end
 
     module NetHTTP
       DEPENDENCIES = ['net/http','uri']
 
-      def get(url,body=nil,headers=nil)
+      def request(klass,url,body=nil,headers=nil)
         uri = URI.parse(url)
         http = Net::HTTP.new(uri.host, uri.port)
-        request = Net::HTTP::Get.new(uri.request_uri)
+        request = klass.new(uri.request_uri)
         headers.map{|k,v|request[k]=v} if headers
+        (request.body = body) if body
         response = http.request(request)
       end
 
-      def post(url,body=nil,headers=nil)
-        uri = URI.parse(url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        request = Net::HTTP::Post.new(uri.request_uri)
-        headers.map{|k,v|request[k]=v} if headers
-        (request.body = body) if body
-        response = http.request(request)
+      %w{get post put}.each do |name|
+        define_method name do |*args|
+          request(Net::HTTP.const_get(name.capitalize),*args)
+        end
       end
+
     end
 
     def initialize
@@ -80,12 +77,8 @@ module Wemote
 
     private
 
-    def _get(lib,url,body=nil,headers=nil)
-      lib.get(url,{body:body,headers:headers})
-    end
-
-    def _post(lib,url,body=nil,headers=nil)
-      lib.post(url,{body:body,headers:headers})
+    def _req(lib,method,url,body=nil,headers=nil)
+      lib.send(method,url,{body:body,headers:headers})
     end
 
   end

data/lib/wemote/collection/switch.rb

@@ -0,0 +1,31 @@
+module Wemote
+  module Collection
+
+    # This class provides an extension on the basic Array object, in order to
+    # facilitate group operations on a collection of Wemote::Switch instances.
+    class Switch < Array
+
+      class << self
+
+        private
+
+        # @macro [attach] container.increment
+        #   @method $1()
+        #   Calls {Wemote::Switch#$1} on all containing elements and return the results in an
+        #   array
+        #   @return [Array]
+        def make(name)
+          define_method(name){map{|s|s.send(name)}}
+        end
+
+      end
+
+      make :toggle!
+      make :off!
+      make :off?
+      make :on!
+      make :on?
+
+    end
+  end
+end

data/lib/wemote/switch.rb

@@ -1,19 +1,14 @@
 require 'socket'
 require 'ipaddr'
+require 'timeout'
 
 module Wemote
+
+  # This class encapsulates an individual Wemo Switch. It provides methods for
+  # getting and setting the switch's state, as well as a {#toggle!} method for
+  # convenience. Finally, it provides the {#poll} method, which accepts a block
+  # to be executed any time the switch changes state.
   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"',
@@ -26,71 +21,95 @@ EOF
     }
 
     class << self
+      # Returns all Switches detected on the local network
+      #
+      # @param [Boolean] refresh Refresh and redetect Switches
+      # @return [Array] all Switches on the network
       def all(refresh=false)
         @switches = nil if refresh
-        @switches ||= fetch_switches
+        @switches ||= Wemote::Collection::Switch.new(discover)
       end
 
+      # Returns a Switch of a given name
+      #
+      # @param name [String] the friendly name of the Switch
+      # @return [Wemote::Switch] a Switch object
       def find(name)
         all.detect{|s|s.name == name}
       end
 
       private
 
-      def ssdp_socket
-        socket = UDPSocket.new
-        socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, IPAddr.new(MULTICAST_ADDR).hton + IPAddr.new(BIND_ADDR).hton)
-        socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, 1)
-        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, 1)
-        socket.bind(BIND_ADDR,PORT)
-        socket
-      end
-
-      def fetch_switches
-        socket = ssdp_socket
-        switches = []
-
-        3.times { socket.send(DISCOVERY, 0, MULTICAST_ADDR, PORT) }
-
-        # The following is a bit silly, but is necessary for JRuby support,
-        # which seems to have some issues with socket interruption.
-        # If you have a working JRuby solution that doesn't require this
-        # kind of hackery, by all means, submit a pull request!
-
-        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)}
-
+      def discover(broadcast = '255.255.255.255')
+        `ping -t 1 #{broadcast} > /dev/null && arp -na | grep b4:75`.split("\n").map do |device|
+          self.new(/\((\d+\.\d+\.\d+\.\d+)\)/.match(device)[1])
+        end.reject{|device| device.instance_variable_get(:@port).nil? }
       end
     end
 
     attr_accessor :name
 
-    def initialize(host,port)
+    def initialize(host,port=nil)
       @host, @port = host, port
       set_meta
     end
 
+    # Turn the Switch on or off, based on its current state
     def toggle!;  on? ? off! : on!;   end
+
+    # Turn the Switch off
     def off!;     set_state(0);       end
-    def off?;     get_state == :off;  end
+
+    # Turn the Switch on
     def on!;      set_state(1);       end
+
+    # Return whether the Switch is off
+    #
+    # @return [Boolean]
+    def off?;     get_state == :off;  end
+
+    # Return whether the Switch is on
+    #
+    # @return [Boolean]
     def on?;      get_state == :on;   end
 
+    # Monitors the state of the Switch via polling, and yields to the block
+    # given with the updated state.
+    #
+    # @example Output when a Switch changes state
+    #   light.poll do |state|
+    #     if state == :on
+    #       puts "The switch turned on"
+    #     else
+    #       puts "The switch turned off"
+    #     end
+    #   end
+    #
+    # @param rate [Float] The rate in seconds at which to poll the switch
+    # @param async [Boolean] Whether or not to poll the switch in a separate thread
+    #
+    # @return [Thread] if the method call was asynchronous
+    def poll(rate=0.25,async=true,&block)
+      old_state = get_state
+      poller = Thread.start do
+        loop do
+          begin
+            state = get_state
+            if state != old_state
+              old_state = state
+              yield state
+            end
+          rescue Exception
+          end
+          sleep rate
+        end
+      end
+      puts "Monitoring #{@name} for changes"
+      async ? poller : poller.join
+    end
+
+    private
+
     def get_state
       response = begin
         client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",Wemote::XML.get_binary_state,GET_HEADERS)
@@ -108,15 +127,26 @@ EOF
       end
     end
 
-    private
-
     def client
       @client ||= Wemote::Client.new
     end
 
     def set_meta
-      response = client.get("http://#{@host}:#{@port}/setup.xml")
-      @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
+      if @port
+        response = client.get("http://#{@host}:#{@port}/setup.xml")
+        @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
+      else
+        for port in 49152..49156
+          begin
+            response = nil
+            Timeout::timeout(1){ response = client.get("http://#{@host}:#{port}/setup.xml") }
+            @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
+            @port = port
+            break
+          rescue Exception
+          end
+        end
+      end
     end
 
   end

data/lib/wemote/version.rb

@@ -1,3 +1,3 @@
 module Wemote
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/wemote/xml.rb

@@ -1,22 +1,23 @@
 module Wemote
   module XML
     class << self
-      TEMPLATES = {}
+      xml_path = File.join(File.dirname(__FILE__),'/../../xml')
+      TEMPLATES = {
+        get_binary_state: File.read(File.join(xml_path,'get_binary_state.xml')),
+        set_binary_state: File.read(File.join(xml_path,'set_binary_state.xml'))
+      }
 
-      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
+      # @return [String] The required XML body for a Wemo binary state request
+      def get_binary_state
+        TEMPLATES[:get_binary_state]
+      end
 
+      # @param [Integer] state Either 1 or 0, for off and on respectively
+      # @return [String] The required XML body for a Wemo binary state set request
+      def set_binary_state(state)
+        TEMPLATES[:set_binary_state].gsub("{{1}}",state.to_s)
       end
+
     end
   end
 end

data/spec/spec_helper.rb

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

data/spec/wemote/switch_spec.rb

@@ -72,22 +72,5 @@ describe Wemote::Switch do
       end
     end
 
-    describe 'get_state' do
-      it 'should return the binary state of the switch' do
-
-        @switch.client.stub(:post).and_return(double('response',body:'<BinaryState>1</BinaryState>'))
-        @switch.get_state.should == :on
-        @switch.client.stub(:post).and_return(double('response',body:'<BinaryState>0</BinaryState>'))
-        @switch.get_state.should == :off
-      end
-    end
-
-    describe 'set_state' do
-      it 'should set the binary state of the switch' do
-        @switch.client.stub(:post).and_return(double('response',body:'Called'))
-        @switch.set_state(1).body.should == 'Called'
-      end
-    end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wemote
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kevin Gisi
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies: []
 description: Wemote is a Ruby-agnostic gem for Wemo light switches
 email:
@@ -17,15 +17,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/wemote.rb
 - lib/wemote/client.rb
+- lib/wemote/collection/switch.rb
 - lib/wemote/switch.rb
 - lib/wemote/version.rb
 - lib/wemote/xml.rb
@@ -38,26 +38,27 @@ homepage: https://github.com/gisikw/wemote
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+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:
+rubyforge_project: 
 rubygems_version: 2.2.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Wemote is a Ruby-agnostic gem for Wemo light switches
 test_files:
 - spec/spec_helper.rb
 - spec/wemote/switch_spec.rb
+has_rdoc: 

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci