lita-sonos-commander 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dc5e325b18f3682e6a3a1dc90e59be191506fb6
-  data.tar.gz: 343895e09282f80ab5c96ff48892b14ad0a4ad79
+  metadata.gz: 2dc8d0e8503926fc073876b3e4e6170a2c5c3dab
+  data.tar.gz: 7c791e151b947184c84fc31c4a8f86d101c6c24c
 SHA512:
-  metadata.gz: 4bd63de801134e7bf98984b4c7ec2dc1358382ebd0384575cc2fcf9fa43253207294557004f5c76fd8b1ce9c8900ac082b2c470fcefa79db9f5ea07b40002558
-  data.tar.gz: 47f4c65ffa13e9794547bf02cbf814c9cea2bd8f6c0ada21f5b05dddc240e6bfc1291b41384c8c7d49e55188b5c7486f9fb13afa4fc29f6d10e6dc45b4b83872
+  metadata.gz: 314e394be338f2c76821623f2cdd25c6b175b8a72db53be18157898077e145605ff453a512be73a87176bba51135668acd7b0a3ddbe0083627e8fabb8a5e58d1
+  data.tar.gz: 21678407ad4fcabecd46f02d9b4ac6f4eb0afbfe6f02d0061fb12c2fb6aeb5a1e4634ed5eb4389bb4bd6d5272116d13b2b369331aaf92b6da45d1dd3428fe864

data/example/{client.rb → 000-client.rb}

@@ -1,7 +1,7 @@
 require 'faye/websocket'
 require 'eventmachine'
 
-EM.run {
+EM.run do
   ws = Faye::WebSocket::Client.new('ws://localhost:8080/sonos/listen')
 
   ws.on :open do |event|
@@ -9,12 +9,10 @@ EM.run {
     ws.send('Hello, world!')
   end
 
-  ws.on :message do |event|
-    p [:message, event.data]
-  end
+  ws.on(:message) { |event| p [:message, event.data] }
 
   ws.on :close do |event|
     p [:close, event.code, event.reason]
     ws = nil
   end
-}
+end

data/example/001-install-node-proxy.session

@@ -0,0 +1,44 @@
+# download the sonos proxy server
+$ git clone https://github.com/dpritchett/sonos-proxy-for-lita-with-node.git
+Cloning into 'sonos-proxy-for-lita-with-node'...
+remote: Counting objects: 114, done.
+remote: Compressing objects: 100% (83/83), done.
+remote: Total 114 (delta 32), reused 111 (delta 30), pack-reused 0
+Receiving objects: 100% (114/114), 55.91 KiB | 773.00 KiB/s, done.
+Resolving deltas: 100% (32/32), done.
+
+$ cd sonos-proxy-for-lita-with-node/
+
+# install yarn package manager
+$ npm install -g yarn
+
+# ask yarn to install all dependencies for this proxy
+$ yarn
+yarn install v1.6.0
+warning package.json: No license field
+warning sonos_proxy_node@1.0.0: No license field
+[1/4] Resolving packages...
+[2/4] Fetching packages...
+[3/4] Linking dependencies...
+[4/4] Building fresh packages...
+Done in 1.47s.
+
+# start the server
+$ node ./server.js
+2018-04-30T12:11:29.284Z INFO Could not find file
+  node_moduels/sonos-http-api/settings.json
+2018-04-30T12:11:29.505Z INFO Presets loaded: { example:
+   { players:
+      [ { roomName: 'Bathroom', volume: 10 },
+        { roomName: 'Kitchen', volume: 10 },
+        { roomName: 'Office', volume: 10 },
+        { roomName: 'Bedroom', volume: 10 },
+        { roomName: 'TV Room', volume: 15 } ],
+     playMode: { shuffle: true, repeat: 'all', crossfade: false },
+     pauseOthers: false,
+     favorite: 'My example favorite' } }
+Looking for Sonos speakers
+2018-04-30T12:11:29.554Z INFO http server listening on port 5005
+close event received
+Lost contact with server: ws://ad0ede69.ngrok.io/sonos/listen
+I don't know how to reconnect yet.  Please help!

data/lib/lita/commander_middleware.rb

@@ -1,4 +1,5 @@
 class Lita::CommanderMiddleware
+  # START:initialize
   def self.build(open_sockets:)
     new(open_sockets: open_sockets).build
   end
@@ -8,7 +9,9 @@ class Lita::CommanderMiddleware
   def initialize(open_sockets:)
     @open_sockets = open_sockets
   end
+  # END:initialize
 
+  # START:socket_building
   def build
     lambda do |env|
       if Faye::WebSocket.websocket?(env)
@@ -26,30 +29,34 @@ class Lita::CommanderMiddleware
     Lita.logger.debug "Sonos client count: #{open_sockets.count}"
     ws
   end
+  # END:socket_building
 
-  def close_socket(ws, event)
-    open_sockets.delete_if { |s| s == ws }
-    Lita.logger.debug "Sonos client count: #{open_sockets.count}"
-    Lita.logger.debug "Socket close: #{[:close, event.code, event.reason]}"
-    ws = nil
+  # START:event_handlers
+  def send_welcome_message(ws)
+    payload = { message: 'Welcome to Lita Sonos Commander!', command: 'echo' }
+    ws.send(payload.to_json)
   end
 
   def handle_message(ws, event)
     ws.send({ message: "ACK: #{event.data}" }.to_json)
   end
 
-  def send_welcome_message(ws)
-    payload = { message: 'Welcome to Lita Sonos Commander!', command: 'echo' }
-    ws.send(payload.to_json)
+  def close_socket(ws, event)
+    open_sockets.delete_if { |s| s == ws }
+    Lita.logger.debug "Sonos client count: #{open_sockets.count}"
+    Lita.logger.debug "Socket close: #{[:close, event.code, event.reason]}"
+    ws = nil
   end
+  # END:event_handlers
 
+  # START:request_handlers
   def handle_env_has_socket
     ws = build_socket(env)
 
     send_welcome_message(ws)
 
     ws.on(:message) { |event| handle_message(ws, event) }
-    ws.on(:close) { close_socket(ws, event) }
+    ws.on(:close) { |event| close_socket(ws, event) }
 
     # Return async Rack response
     ws.rack_response
@@ -62,4 +69,5 @@ class Lita::CommanderMiddleware
       ['Hello from a Lita chatbot! Feed me a websocket connection!']
     ]
   end
+  # END:request_handlers
 end

data/lita-sonos-commander.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-sonos-commander'
-  spec.version       = '1.1.1'
+  spec.version       = '1.1.2'
   spec.authors       = ['Daniel J. Pritchett']
   spec.email         = ['dpritchett@gmail.com']
   spec.description   = 'Control your Sonos with Lita chatbot commands'
@@ -14,8 +14,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  # START:runtime_dependency
   spec.add_runtime_dependency 'lita', '>= 4.7'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.10.7'
+  # END:runtime_dependency
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'pry-byebug'

data/spec/lita/commander_middleware_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'ostruct'
 require 'date'
 
+# START:lambda_basic
 describe Lita::CommanderMiddleware do
   let(:handler) { double 'handler' }
   let(:result) { subject.build({}) }
@@ -14,7 +15,9 @@ describe Lita::CommanderMiddleware do
     result = subject.build
     expect(result.is_a?(Proc)).to be_truthy
   end
+  # END:lambda_basic
 
+  # START:add_client
   context 'adding a new client' do
     before { Faye::WebSocket.stub(:new).and_return(a_socket) }
     let(:result) { subject.build_socket(nil) }
@@ -27,6 +30,7 @@ describe Lita::CommanderMiddleware do
       expect(open_sockets).to include(result)
     end
   end
+  # END:add_client
 
   context 'client disconnects' do
     let(:event) { double 'socket event' }

data/spec/lita/handlers/sonos_commander_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'pry'
 require 'date'
 
 describe Lita::Handlers::SonosCommander, lita_handler: true do
@@ -16,15 +15,15 @@ describe Lita::Handlers::SonosCommander, lita_handler: true do
 
     it {
       is_expected.to(route('Lita play url http://zombo.com')
-      .to(:handle_sonos_play_url))
+        .to(:handle_sonos_play_url))
     }
     it {
       is_expected.to(route('Lita play url https://www.youtube.com/watch?v=dQw4w9WgXcQ')
-      .to(:handle_sonos_play_url))
+        .to(:handle_sonos_play_url))
     }
     it {
       is_expected.to(route('Lita speak words i like turtles')
-      .to(:handle_sonos_say_text))
+        .to(:handle_sonos_say_text))
     }
 
     it { is_expected.to route_event(:loaded).to(:register_faye) }
@@ -85,6 +84,7 @@ describe Lita::Handlers::SonosCommander, lita_handler: true do
     end
   end
 
+  # START:faye_hookup
   describe 'socket middleware registration' do
     let(:middlewares) { double 'middlewares' }
     before { subject.stub(:middleware_registry).and_return(middlewares) }
@@ -98,17 +98,23 @@ describe Lita::Handlers::SonosCommander, lita_handler: true do
       subject.register_faye(nil)
     end
   end
+  # END:faye_hookup
 
+  # START:create_sockets
   describe ':websocket_creator' do
     let(:request) { double 'request' }
     let(:request_env) { double 'request' }
     let(:middleware) { double 'middleware' }
+    let(:middlewares) { double 'middlewares' }
 
-    before { subject.stub_chain(:middleware_registry, :each).and_return [middleware] }
+    before { subject.stub_chain(:middleware_registry).and_return [middlewares] }
+    before { middlewares.stub(:middleware).and_return middleware }
     before { request.stub(:env).and_return(request_env) }
 
     it 'passes incoming any request environments to registered middlewares' do
+      expect(middleware).to receive(:call).with(request_env)
       subject.websocket_creator(request, nil)
     end
   end
+  # END:create_sockets
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-sonos-commander
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Daniel J. Pritchett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -150,7 +150,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- example/client.rb
+- example/000-client.rb
+- example/001-install-node-proxy.session
 - lib/lita-sonos-commander.rb
 - lib/lita/commander_middleware.rb
 - lib/lita/handlers/sonos_commander.rb