frisky 0.1.0

data/spec/unit/frisky/ssdp/notifier_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'frisky/ssdp/notifier'
+
+
+describe Frisky::SSDP::Notifier do
+  around(:each) do |example|
+    EM.synchrony do
+      example.run
+      EM.stop
+    end
+  end
+
+  let(:nt) { 'en tee' }
+  let(:usn) { 'you ess en' }
+  let(:ddf_url) { 'ddf url' }
+  let(:duration) { 567 }
+
+  subject do
+    Frisky::SSDP::Notifier.new(1, nt, usn, ddf_url, duration)
+  end
+
+  describe '#initialize' do
+    it 'creates a notification' do
+      expect_any_instance_of(Frisky::SSDP::Notifier).to receive(:notification).
+        with(nt, usn, ddf_url, duration)
+
+      subject
+    end
+  end
+
+  describe '#post_init' do
+    context 'send_datagram returns positive value' do
+      before do
+        expect(subject).to receive(:send_datagram).and_return 1
+      end
+
+      it 'logs what was sent' do
+        expect(subject).to receive(:log).with /Sent notification/
+
+        subject.post_init
+      end
+    end
+
+    context 'send_datagram returns 0' do
+      before do
+        expect(subject).to receive(:send_datagram).and_return 0
+      end
+
+      it 'does not log what was sent' do
+        expect(subject).to_not receive(:log)
+
+        subject.post_init
+      end
+    end
+  end
+
+  describe '#notification' do
+    before do
+      subject.instance_variable_set(:@os, 'my OS')
+    end
+
+    it 'builds the notification message' do
+      expect(subject.notification(nt, usn, ddf_url, duration)).to eq <<-NOTE
+NOTIFY * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+CACHE-CONTROL: max-age=567\r
+LOCATION: ddf url\r
+NT: en tee\r
+NTS: ssdp:alive\r
+SERVER: my OS UPnP/1.0 Frisky/#{Frisky::VERSION}\r
+USN: you ess en\r
+\r
+      NOTE
+    end
+  end
+end

data/spec/unit/frisky/ssdp/searcher_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'frisky/ssdp/searcher'
+
+
+describe Frisky::SSDP::Searcher do
+  around(:each) do |example|
+    EM.synchrony do
+      example.run
+      EM.stop
+    end
+  end
+
+  before do
+    Frisky.logging_enabled = false
+    allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:setup_multicast_socket)
+  end
+
+  subject do
+    Frisky::SSDP::Searcher.new(1, 'ssdp:all', {})
+  end
+
+  it 'lets you read its responses' do
+    responses = double 'responses'
+    subject.instance_variable_set(:@discovery_responses, responses)
+    expect(subject.discovery_responses).to eq responses
+  end
+
+  describe '#initialize' do
+    it 'does an #m_search' do
+      expect_any_instance_of(Frisky::SSDP::Searcher).to receive(:m_search).and_return(<<-MSEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: "ssdp:discover"\r
+MX: 5\r
+ST: ssdp:all\r
+\r
+      MSEARCH
+      )
+      subject
+    end
+  end
+
+  describe '#receive_data' do
+    let(:parsed_response) do
+      parsed_response = double 'parsed response'
+      expect(parsed_response).to receive(:has_key?).with(:nts).and_return false
+      expect(parsed_response).to receive(:[]).and_return false
+
+      parsed_response
+    end
+
+    it 'takes a response and adds it to the list of responses' do
+      response = double 'response'
+      allow(subject).to receive(:peer_info).and_return(['0.0.0.0', 4567])
+
+      expect(subject).to receive(:parse).with(response).exactly(1).times.
+        and_return(parsed_response)
+      expect(subject.instance_variable_get(:@discovery_responses)).to receive(:<<).
+        with(parsed_response)
+
+      subject.receive_data(response)
+    end
+  end
+
+  describe '#post_init' do
+    before { allow_any_instance_of(Frisky::SSDP::Searcher).to receive(:m_search).and_return('hi') }
+
+    it 'sends an M-SEARCH as a datagram over 239.255.255.250:1900' do
+      m_search_count_times = subject.instance_variable_get(:@m_search_count)
+      expect(subject).to receive(:send_datagram).
+        with('hi', '239.255.255.250', 1900).
+        exactly(m_search_count_times).times.
+        and_return 0
+      subject.post_init
+    end
+  end
+
+  describe '#m_search' do
+    it 'builds the MSEARCH string using the given parameters' do
+      expect(subject.m_search('ssdp:all', 10)).to eq <<-MSEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: "ssdp:discover"\r
+MX: 10\r
+ST: ssdp:all\r
+\r
+      MSEARCH
+    end
+
+    it 'uses 239.255.255.250 as the HOST IP' do
+      expect(subject.m_search('ssdp:all', 10)).to match(/HOST: 239.255.255.250/m)
+    end
+
+    it 'uses 1900 as the HOST port' do
+      expect(subject.m_search('ssdp:all', 10)).to match(/HOST:.*1900/m)
+    end
+
+    it 'lets you search for undefined search target types' do
+      expect(subject.m_search('spaceship', 10)).to eq <<-MSEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: "ssdp:discover"\r
+MX: 10\r
+ST: spaceship\r
+\r
+      MSEARCH
+    end
+  end
+end
+

data/spec/unit/frisky/ssdp_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+require 'frisky/ssdp'
+
+
+describe Frisky::SSDP do
+  subject { Frisky::SSDP }
+
+  describe '.listen' do
+    let(:listener) do
+      searcher = double 'Frisky::SSDP::Listener'
+      searcher.stub_chain(:alive_notifications, :pop).and_yield(%w[one two])
+      searcher.stub_chain(:byebye_notifications, :pop).and_yield(%w[three four])
+
+      searcher
+    end
+
+    before do
+      allow(EM).to receive(:run).and_yield
+      allow(EM).to receive(:add_timer)
+      allow(EM).to receive(:open_datagram_socket).and_return listener
+    end
+
+    context 'reactor is already running' do
+      it 'returns a Frisky::SSDP::Listener' do
+        allow(EM).to receive(:reactor_running?).and_return true
+        expect(subject.listen).to eq listener
+      end
+    end
+
+    context 'reactor is not already running' do
+      it 'returns a Hash of available and byebye responses' do
+        allow(EM).to receive(:add_shutdown_hook).and_yield
+        expect(subject.listen).to eq({
+          alive_notifications: %w[one two],
+          byebye_notifications: %w[three four]
+        })
+      end
+
+      it 'opens a UDP socket on 239.255.255.250, port 1900' do
+        allow(EM).to receive(:add_shutdown_hook)
+        expect(EM).to receive(:open_datagram_socket).with('239.255.255.250', 1900,
+          Frisky::SSDP::Listener, 4)
+        subject.listen
+      end
+    end
+  end
+
+  describe '.search' do
+    let(:multicast_searcher) do
+      searcher = double 'Frisky::SSDP::Searcher'
+      searcher.stub_chain(:discovery_responses, :subscribe).and_yield(%w[one two])
+
+      searcher
+    end
+
+    let(:broadcast_searcher) do
+      searcher = double 'Frisky::SSDP::BroadcastSearcher'
+      searcher.stub_chain(:discovery_responses, :subscribe).and_yield(%w[three four])
+
+      searcher
+    end
+
+    before do
+      allow(EM).to receive(:run).and_yield
+      allow(EM).to receive(:add_timer)
+      allow(EM).to receive(:open_datagram_socket).and_return multicast_searcher
+    end
+
+    context 'when search_target is not a String' do
+      it 'calls #to_upnp_s on search_target' do
+        search_target = double('search_target')
+        expect(search_target).to receive(:to_upnp_s)
+        subject.search(search_target)
+      end
+    end
+
+    context 'when search_target is a String' do
+      it 'calls #to_upnp_s on search_target but does not alter it' do
+        search_target = "I'm a string"
+        expect(search_target).to receive(:to_upnp_s).and_call_original
+
+        expect(EM).to receive(:open_datagram_socket).with('0.0.0.0', 0,
+          Frisky::SSDP::Searcher, "I'm a string", {})
+        subject.search(search_target)
+      end
+    end
+
+    context 'reactor is already running' do
+      it 'returns a Frisky::SSDP::Searcher' do
+        allow(EM).to receive(:reactor_running?).and_return true
+        expect(subject.search).to eq multicast_searcher
+      end
+    end
+
+    context 'reactor is not already running' do
+      context 'options hash includes do_broadcast_search' do
+        before do
+          allow(EM).to receive(:open_datagram_socket).
+            and_return(multicast_searcher, broadcast_searcher)
+        end
+
+        it 'returns an Array of responses' do
+          allow(EM).to receive(:add_shutdown_hook).and_yield
+          expect(subject.search(:all, do_broadcast_search: true)).to eq %w[one two three four]
+        end
+
+        it 'opens 2 UDP sockets on 0.0.0.0, port 0' do
+          allow(EM).to receive(:add_shutdown_hook)
+          expect(EM).to receive(:open_datagram_socket).with('0.0.0.0', 0, Frisky::SSDP::Searcher,
+            'ssdp:all', {})
+          expect(EM).to receive(:open_datagram_socket).with('0.0.0.0', 0, Frisky::SSDP::BroadcastSearcher,
+            'ssdp:all', 5, 4)
+          subject.search(:all, do_broadcast_search: true)
+        end
+      end
+
+      context 'options hash does not include do_broadcast_search' do
+        it 'returns an Array of responses' do
+          allow(EM).to receive(:add_shutdown_hook).and_yield
+          expect(subject.search).to eq %w[one two]
+        end
+
+        it 'opens a UDP socket on 0.0.0.0, port 0' do
+          allow(EM).to receive(:add_shutdown_hook)
+          expect(EM).to receive(:open_datagram_socket).with('0.0.0.0', 0, Frisky::SSDP::Searcher,
+            'ssdp:all', {})
+          subject.search
+        end
+      end
+    end
+  end
+
+  describe '.notify' do
+    pending 'Implementation of UPnP Devices'
+  end
+
+  describe '.send_notification' do
+    pending 'Implementation of UPnP Devices'
+  end
+
+=begin
+    context 'by default' do
+      it "searches for 'ssdp:all'" do
+        pending
+      end
+
+      it 'waits for 5 seconds for responses' do
+        before = Time.now
+
+        SSDP.search
+
+        after = Time.now
+        (after - before).should < 5.1
+        (after - before).should > 5.0
+      end
+    end
+
+    context "finds 'upnp:rootdevice's" do
+      it "by using the spec's string 'upnp:rootdevice'" do
+        SSDP.search('upnp:rootdevice').should == [
+          {
+            :cache_control=>'max-age=1200',
+            :date=>'Mon, 26 Sep 2011 06:40:19 GMT',
+            :location=>'http://192.168.10.3:5001/description/fetch',
+            :server=>'Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1',
+            :st=>'upnp:rootdevice',
+            :ext=>'',
+            :usn=>'uuid:3c202906-992d-3f0f-b94c-90e1902a136d::upnp:rootdevice',
+            :content_length=>'0'
+          }
+        ]
+      end
+
+      it 'by using :root' do
+        pending
+      end
+    end
+
+    it 'can wait for user-defined seconds for responses' do
+      before = Time.now
+
+      SSDP.search(:all, 1)
+
+      after = Time.now
+      (after - before).should < 1.1
+      (after - before).should > 1.0
+    end
+
+    it 'finds a device by its URN' do
+      pending
+    end
+
+    it 'finds a device by its UUID' do
+      pending
+    end
+
+    it 'finds a device by its UPnP device type' do
+      pending
+    end
+
+    it 'finds a device by its UPnP device type using a non-standard domain name' do
+      pending
+    end
+
+    it 'finds a service by its UPnP service type' do
+      pending
+    end
+
+    it 'find a service by its UPnP service type using a non-standard domain name' do
+      pending
+    end
+=end
+end
+

data/tasks/search.thor

@@ -0,0 +1,35 @@
+require 'pp'
+require File.expand_path(File.dirname(__FILE__)+ '/../lib/frisky/ssdp')
+require File.expand_path(File.dirname(__FILE__)+ '/../lib/frisky/logger')
+
+module Frisky
+  class Ssdp < Thor
+    #---------------------------------------------------------------------------
+    # search
+    #---------------------------------------------------------------------------
+    desc 'search TARGET', 'Searches for devices of type TARGET'
+    method_option :response_wait_time, default: 5
+    method_option :ttl, default: 4
+    method_option :do_broadcast_search, type: :boolean
+    method_option :log, type: :boolean
+    def search(target='upnp:rootdevice')
+      ::Frisky.logging_enabled = options[:log]
+      time_before = Time.now
+      results     = ::Frisky::SSDP.search(target, options.dup)
+                    .map { |r| r[:location] }
+                    .sort
+      unique      = results.uniq
+      time_after  = Time.now
+
+      puts <<-RESULTS
+size: #{results.size}
+locations: #{results.join("\n           ")}
+unique size: #{unique.size}
+unique locations: #{unique.join("\n                  ")}
+search duration: #{time_after - time_before}
+      RESULTS
+
+      results
+    end
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: frisky
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Frisby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: log_switch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |-
+  frisky provides the tools you need to build an app that runs
+  in a UPnP environment.
+email: jfrisby@mrjoy.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.md
+- README.md
+- LICENSE.md
+files:
+- ".gemtest"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- History.md
+- LICENSE.md
+- README.md
+- Rakefile
+- features/device_discovery.feature
+- features/step_definitions/.gitkeep
+- features/support/env.rb
+- features/support/world_extensions.rb
+- frisky.gemspec
+- lib/core_ext/hash_patch.rb
+- lib/core_ext/socket_patch.rb
+- lib/core_ext/to_upnp_s.rb
+- lib/frisky.rb
+- lib/frisky/logger.rb
+- lib/frisky/ssdp.rb
+- lib/frisky/ssdp/broadcast_searcher.rb
+- lib/frisky/ssdp/error.rb
+- lib/frisky/ssdp/listener.rb
+- lib/frisky/ssdp/multicast_connection.rb
+- lib/frisky/ssdp/network_constants.rb
+- lib/frisky/ssdp/notifier.rb
+- lib/frisky/ssdp/searcher.rb
+- lib/frisky/version.rb
+- spec/spec_helper.rb
+- spec/support/search_responses.rb
+- spec/unit/core_ext/to_upnp_s_spec.rb
+- spec/unit/frisky/ssdp/listener_spec.rb
+- spec/unit/frisky/ssdp/multicast_connection_spec.rb
+- spec/unit/frisky/ssdp/notifier_spec.rb
+- spec/unit/frisky/ssdp/searcher_spec.rb
+- spec/unit/frisky/ssdp_spec.rb
+- tasks/search.thor
+homepage: http://github.com/MrJoy/frisky
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Use me to build a UPnP app!
+test_files:
+- features/device_discovery.feature
+- features/step_definitions/.gitkeep
+- features/support/env.rb
+- features/support/world_extensions.rb
+- spec/spec_helper.rb
+- spec/support/search_responses.rb
+- spec/unit/core_ext/to_upnp_s_spec.rb
+- spec/unit/frisky/ssdp/listener_spec.rb
+- spec/unit/frisky/ssdp/multicast_connection_spec.rb
+- spec/unit/frisky/ssdp/notifier_spec.rb
+- spec/unit/frisky/ssdp/searcher_spec.rb
+- spec/unit/frisky/ssdp_spec.rb
+has_rdoc: