wemote 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8691a6386c98200751335860a3601d8377df98a
-  data.tar.gz: c24270bd139e1065b1a7e2e33695629241397bc1
+  metadata.gz: b18903132febc3de01e2796ce0b7adde752b030f
+  data.tar.gz: 07503eba981f501449f2b6f86afb90baca0ad7c7
 SHA512:
-  metadata.gz: ae867770e792ab4ab14a25147a94f8f18bd5ebd4297cdce837bc78c41bc286dc20d11dd24267336680001fecddf2822ab8dc03d74f3ab431b8b57d792c65a1e9
-  data.tar.gz: 3f9008db4572c37f11c4fd0a6082e55afae6a827fb82cb6250eb27fb0351a447d464de2424ccadcb9a65a24d2b0c2471449fac515546ab3931f5892f7e19774c
+  metadata.gz: 3313aa5e43f3394d505f9a2b6c7dbfe06dc6f49effaaea8b86e43542e93f5cb4583793631b34cd6fac99be1aa3440e4ca3b9b40320a8d4ba36fea52418e1662a
+  data.tar.gz: ad62e4b4497c8509246861e52479b677ce495d1859103fbd67823552af6b92f346ad7972cd1dbc8f54e1b7129aa52429172691be75eb2331e639bd09e879b237

data/.coveralls.yml

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

data/.travis.yml

@@ -1,3 +1,8 @@
 language: ruby
 rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - rbx
+  - ruby-head
   - jruby-head

data/Gemfile

@@ -1,9 +1,10 @@
 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'
+# 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,20 +1,20 @@
-# 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 [![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 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.
+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.
 
 ## Installation
 
-First, clone the repository:
+Add this line to your application's Gemfile:
 
-    git clone https://github.com/gisikw/wemote.git
+    gem 'wemote'
 
 And then execute:
 
-    $ gem build wemote.gemspec
+    $ bundle
 
-Finally, run:
+Or install it yourself as:
 
-    $ gem install wemote-0.0.1.gem
+    $ gem install wemote
 
 ## Usage
 
@@ -32,7 +32,7 @@ switch = Wemote::Switch.find('Kitchen Switch') #=> #<Remo::Switch:0x27f33aef @ho
 
 Given a Switch instance, you can call the following methods:
 ```ruby
-switch.state #=> ["off","on"]
+switch.get_state #=> [:off,:on]
 switch.off? #=> [true,false]
 switch.on? #=> [true,false]
 switch.on!
@@ -40,6 +40,10 @@ switch.off!
 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.
+
 ## Contributing
 
 1. Fork it

data/lib/wemote.rb

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

data/lib/wemote/client.rb

@@ -0,0 +1,92 @@
+module Wemote
+  class Client
+
+    def self.technique
+      @technique ||= begin
+        constants.collect {|const_name| const_get(const_name)}.select {|const| const.class == Module}.detect do |mod|
+          fulfilled = false
+          begin
+            mod.const_get(:DEPENDENCIES).map{|d|require d}
+            fulfilled = true
+          rescue LoadError
+          end
+          fulfilled
+        end
+      end
+    end
+
+    module Manticore
+      DEPENDENCIES = ['manticore']
+
+      def get(*args)
+        _get(::Manticore,*args).call
+      end
+
+      def post(*args)
+        _post(::Manticore,*args).call
+      end
+
+    end
+
+    module Typhoeus
+      DEPENDENCIES = ['typhoeus']
+
+      def get(*args)
+        _get(::Typhoeus,*args)
+      end
+
+      def post(*args)
+        _post(::Typhoeus,*args)
+      end
+
+    end
+
+    module HTTParty
+      DEPENDENCIES = ['httparty']
+
+      def get(*args)
+        _get(::HTTParty,*args)
+      end
+
+      def post(*args)
+        _post(::HTTParty,*args)
+      end
+    end
+
+    module NetHTTP
+      DEPENDENCIES = ['net/http','uri']
+
+      def get(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)
+        headers.map{|k,v|request[k]=v} if headers
+        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)
+      end
+    end
+
+    def initialize
+      extend Wemote::Client.technique
+    end
+
+    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})
+    end
+
+  end
+end

data/lib/wemote/switch.rb

@@ -37,19 +37,26 @@ EOF
 
       private
 
-      def fetch_switches
+      def ssdp_socket
         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_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
@@ -86,31 +93,30 @@ EOF
 
     def get_state
       response = begin
-        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",:body => Wemote::XML.get_binary_state, :headers => GET_HEADERS).call
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",Wemote::XML.get_binary_state,GET_HEADERS)
       rescue Exception
-        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",:body => Wemote::XML.get_binary_state, :headers => GET_HEADERS).call
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",Wemote::XML.get_binary_state,GET_HEADERS)
       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
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",Wemote::XML.set_binary_state(state),SET_HEADERS)
       rescue Exception
-        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",:body => Wemote::XML.set_binary_state(state), :headers => SET_HEADERS).call
+        client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",Wemote::XML.set_binary_state(state),SET_HEADERS)
       end
     end
 
     private
 
     def client
-      @client ||= Manticore::Client.new
+      @client ||= Wemote::Client.new
     end
 
     def set_meta
-      client.get("http://#{@host}:#{@port}/setup.xml") do |response|
-        @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
-      end
+      response = client.get("http://#{@host}:#{@port}/setup.xml")
+      @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
     end
 
   end

data/lib/wemote/version.rb

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

data/spec/spec_helper.rb

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

data/spec/wemote/switch_spec.rb

@@ -9,8 +9,8 @@ describe Wemote::Switch do
 
     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)
+        client = Wemote::Client.new
+        client.stub(:get).and_return(double('response',{body:'<friendlyName>Test Switch</friendlyName>'}))
         Wemote::Switch.any_instance.stub(:client).and_return(client)
         switch = Wemote::Switch.new('fakehost','1234')
         Wemote::Switch.instance_variable_set(:@switches,[switch])
@@ -22,8 +22,8 @@ describe Wemote::Switch do
 
   describe 'instance methods' do
     before do
-      client = Manticore::Client.new
-      client.stub('http://fakehost:1234/setup.xml',body:'<friendlyName>Test Switch</friendlyName>',code:200)
+      client = Wemote::Client.new
+      client.stub(:get).and_return(double('response',body:'<friendlyName>Test Switch</friendlyName>'))
       Wemote::Switch.any_instance.stub(:client).and_return(client)
       @switch = Wemote::Switch.new('fakehost','1234')
     end
@@ -74,16 +74,17 @@ describe Wemote::Switch do
 
     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.client.stub(:post).and_return(double('response',body:'<BinaryState>1</BinaryState>'))
         @switch.get_state.should == :on
-        @switch.client.stub('http://fakehost:1234/upnp/control/basicevent1',body:'<BinaryState>0</BinaryState>',code:200)
+        @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('http://fakehost:1234/upnp/control/basicevent1',body:'Called',code:200)
+        @switch.client.stub(:post).and_return(double('response',body:'Called'))
         @switch.set_state(1).body.should == 'Called'
       end
     end

data/wemote.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.description   = %q{Wemote is a Ruby-agnostic gem for Wemo light switches}
+  spec.summary       = %q{Wemote is a Ruby-agnostic gem for Wemo light switches}
   spec.homepage      = "https://github.com/gisikw/wemote"
   spec.license       = "MIT"
   spec.platform      = 'ruby'
@@ -18,6 +18,4 @@ Gem::Specification.new do |spec|
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wemote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Gisi
@@ -9,28 +9,15 @@ 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
+dependencies: []
+description: Wemote is a Ruby-agnostic gem for Wemo light switches
 email:
 - kevin@kevingisi.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -38,6 +25,7 @@ files:
 - README.md
 - Rakefile
 - lib/wemote.rb
+- lib/wemote/client.rb
 - lib/wemote/switch.rb
 - lib/wemote/version.rb
 - lib/wemote/xml.rb
@@ -69,7 +57,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key:
 specification_version: 4
-summary: Wemote is a JRuby-friendly API for Wemo light switches
+summary: Wemote is a Ruby-agnostic gem for Wemo light switches
 test_files:
 - spec/spec_helper.rb
 - spec/wemote/switch_spec.rb