doxie-scanner 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d19094d1abad744e8bf10c3e9c1fddf14459be1158db960c460a61ed9e76123
-  data.tar.gz: 32e13587cd42cdddfbc070384d6c31d20948ea93cb138450606db8529326ca86
+  metadata.gz: 40d9bc6a4652f5e0583fa1afa774bd4da8923d73478b7da3eac9412767d2a5f8
+  data.tar.gz: 6d6e799b5bb6420d97dd6efd284ca7cdef53bd31a565c54c285730da0478ab90
 SHA512:
-  metadata.gz: f6c217d412b6aec0e69d04c2d781fd8152846b4ea4126f838e6113b83d9564db39de1bf7c6b5dff48fcf25b173d499b84414c59da1277f194c62b9a4c8b0dabc
-  data.tar.gz: 3061edd67b68532ad3b3118394b91b2ecbfd31298e35f671d097fc5f75f44e89b93310f8314c5739b50c72d1b8f198a2e526377bdbfb1fa7bdd7e7719a85629e
+  metadata.gz: cd4bbddd1fb17295e71de69a64d1e4ce9de5961233eb6df7ba13d49ac651be6b788d42aa0f3b4101b107b376c5218e23fd788ceb63c74977aa6f7ee1b390a3bd
+  data.tar.gz: 6abc7acd5698f9b4c655898e5b226104bb5e16e589fed90e0f4f9033d5f2fccb986889c1f12ef8ca2ae6db4555e45d7e982c7fcf7aa734116756a27d65494ea8

data/README.md

@@ -26,6 +26,15 @@ Doxie::Scanner.ips
 ]
 ```
 
+For usage with the [Doxie client library](https://github.com/cbetta/doxie) you can use the `.devices` method to automatically detect the model number and IP.
+
+```rb
+require 'doxie'
+require 'doxie/scanner'
+
+client = Doxie::Client.new(Doxie::Scanner.devices.first)
+```
+
 ## Contributing
 
  1. **Fork** the repo on GitHub

data/doxie-scanner.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'doxie-scanner'
-  s.version     =  '1.1.0'
-  s.summary     = "A simple scanner for your Doxie Go Wifi"
-  s.description = "A simple scanner for your Doxie Go Wifi"
+  s.version     =  '1.2.0'
+  s.summary     = "A simple scanner for your Wifi enabled Doxie scanner"
+  s.description = "A simple scanner for your Wifi enabled Doxie scanner"
   s.authors     = ["Cristiano Betta"]
-  s.email       = 'cbetta@gmail.com'
+  s.email       = 'cristiano@betta.io'
   s.files       = Dir.glob('{lib,spec}/**/*') + %w(LICENSE README.md doxie-scanner.gemspec)
   s.homepage    = 'https://github.com/cbetta/doxie-scanner'
   s.license     = 'MIT'

data/lib/doxie/scanner.rb

@@ -8,5 +8,23 @@ module Doxie
       hosts = doxies.map {|doxie| URI.parse(doxie[:location]).host }
       hosts.uniq
     end
+
+    def self.devices(frisky = Frisky::SSDP)
+      root_devices = frisky.search 'upnp:rootdevices'
+      doxies = root_devices.select { |device| device[:location].include?('doxie')}
+      hosts = doxies.map do |doxie| 
+        {
+          ip: URI.parse(doxie[:location]).host,
+          model: Doxie::Scanner.api_version(doxie[:server])
+        }
+      end
+      hosts.uniq
+    end
+
+    private
+
+    def self.api_version server
+      server.include?('DX250') ? "API_V1" : "API_V2"
+    end
   end
 end

data/spec/doxie/scanner_spec.rb

@@ -4,32 +4,65 @@ require 'doxie/scanner'
 describe 'Doxie::Scanner' do
   before do 
     @frisky = Minitest::Mock.new
-    @return_value = []
     @args = ['upnp:rootdevices']
+    @return_value = []
   end
 
-  it 'should search for upnp:rootdevices' do
-    @frisky.expect :search, @return_value, @args
-    ips = Doxie::Scanner.ips(@frisky)
-    @frisky.verify
-    assert_equal ips, @return_value
-  end
+  describe '.ips' do
+    it 'should search for upnp:rootdevices' do
+      @frisky.expect :search, @return_value, @args
+      ips = Doxie::Scanner.ips(@frisky)
+      @frisky.verify
+      assert_equal ips, @return_value
+    end
+    
+    it 'should extract the host names for doxie devices' do
+      @frisky.expect :search, [
+        { location: "http://127.0.0.1/doxie/foo" },
+        { location: "http://127.0.0.2/doksy/foo" },
+      ], @args
+      ips = Doxie::Scanner.ips(@frisky)
+      assert_equal ips, ['127.0.0.1']
+    end
   
-  it 'should extract the host names for doxie devices' do
-    @frisky.expect :search, [
-      { location: "http://127.0.0.1/doxie/foo" },
-      { location: "http://127.0.0.2/doksy/foo" },
-    ], @args
-    ips = Doxie::Scanner.ips(@frisky)
-    assert_equal ips, ['127.0.0.1']
+    it 'should only find unique host names' do
+      @frisky.expect :search, [
+        { location: "http://127.0.0.1/doxie/foo" },
+        { location: "http://127.0.0.1/doxie/foo" },
+      ], @args
+      ips = Doxie::Scanner.ips(@frisky)
+      assert_equal ips.length, 1
+    end
   end
 
-  it 'should only find unique host names' do
-    @frisky.expect :search, [
-      { location: "http://127.0.0.1/doxie/foo" },
-      { location: "http://127.0.0.1/doxie/foo" },
-    ], @args
-    ips = Doxie::Scanner.ips(@frisky)
-    assert_equal ips.length, 1
+  describe '.devices' do
+    it 'should search for upnp:rootdevices' do
+      @frisky.expect :search, @return_value, @args
+      devices = Doxie::Scanner.devices(@frisky)
+      @frisky.verify
+      assert_equal devices, @return_value
+    end
+    
+    it 'should extract the host names and api version number for doxie devices' do
+      @frisky.expect :search, [
+        { location: "http://127.0.0.1/doxie/foo", server: 'Linux/2.6.30.9, UPnP/1.0, DoxieDX300/1.08' },
+        { location: "http://127.0.0.2/doxie/foo", server: 'Linux/2.6.30.9, UPnP/1.0, DoxieDX250/1.08' },
+        { location: "http://127.0.0.3/noxie/foo", server: 'Linux/2.6.30.9, UPnP/1.0, Noxie/1.08' },
+      ], @args
+      devices = Doxie::Scanner.devices(@frisky)
+      assert_equal devices, [
+        { ip: '127.0.0.1', model: 'API_V2' },
+        { ip: '127.0.0.2', model: 'API_V1' },
+      ]
+    end
+  
+    it 'should only find unique host names' do
+      @frisky.expect :search, [
+        { location: "http://127.0.0.1/doxie/foo", server: 'Linux/2.6.30.9, UPnP/1.0, DoxieDX300/1.08' },
+        { location: "http://127.0.0.1/doxie/foo", server: 'Linux/2.6.30.9, UPnP/1.0, DoxieDX300/1.08' },
+      ], @args
+      devices = Doxie::Scanner.devices(@frisky)
+      assert_equal devices.length, 1
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doxie-scanner
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Cristiano Betta
@@ -52,8 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple scanner for your Doxie Go Wifi
-email: cbetta@gmail.com
+description: A simple scanner for your Wifi enabled Doxie scanner
+email: cristiano@betta.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -86,5 +86,5 @@ requirements: []
 rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
-summary: A simple scanner for your Doxie Go Wifi
+summary: A simple scanner for your Wifi enabled Doxie scanner
 test_files: []