ownet 0.1.0 → 0.2.0

data/lib/connection.rb

@@ -34,7 +34,7 @@ module OWNet
     
     def initialize(opts={})
       opts.each {|name, value| self.send(name.to_s+'=', value)}
-      @flags = 258
+      @flags = 258 #FIXME: What is this?
     end
     
     private
@@ -43,7 +43,7 @@ module OWNet
       data_len = 0
       case self.function
       when READ
-        data_len = 8192
+        data_len = 8192 #FIXME: What is this?
       when WRITE
         payload_len = path.size + 1 + value.size + 1
         data_len = value.size
@@ -73,11 +73,12 @@ module OWNet
     def initialize(socket)
       data = socket.read(24)
       raise ShortRead if !data || data.size != 24
-      
+        
       version, @payload_len, self.return_value, @format_flags,
       @data_len, @offset = data.unpack('NNNNNN')
       
       if @payload_len > 0 && !isping? 
+        #FIXME: Guard against a short read here
         @data = socket.read(@payload_len)[@offset..@data_len+@offset-1] 
       end
     end
@@ -102,6 +103,65 @@ module OWNet
     # Connection.new(:port=>20200)
     # #Connect to a remote server on a non-standard port:
     # Connection.new(:server=>"my.server.com", :port=>20200)
+    def initialize(opts={})
+      @conn = RawConnection.new(opts)
+      @serialcache = {}
+    end
+
+    def read(path); do_op(:read, path); end
+    def dir(path); do_op(:dir, path); end
+    def write(path, value); @conn.send(:write, path, value); end
+
+    private
+    def do_op(op, path)
+      basepath = "/"
+      if path[0..8] == "/uncached"
+        path = path[9..-1]
+        basepath = "/uncached"
+      end
+      serial = path[1..15]
+      ret = if cachepath = @serialcache[serial]
+        @conn.send(op, cachepath+path[16..-1])
+      else
+        @conn.send(op, path)
+      end
+      if (ret.nil? or ret == []) and serial =~ /[0-9A-Z]{2,2}\.[0-9A-Z]{12,12}/
+        if newbasepath = find_recursive(serial, basepath)
+          @serialcache[serial] = newbasepath
+          newpath = newbasepath+path[16..-1]
+          ret = @conn.send(op, newpath)
+        end
+      end
+      ret
+    end
+
+    def find_recursive(serial,path,depth=0)
+      if depth > 5
+        return nil
+      end
+      dirs = @conn.send(:dir, path)||[]
+      dirs.each do |dir|
+        dir = dir.split("/")[-1]
+        if dir == serial
+          return path+"/"+serial
+        elsif dir =~ /1F\.[0-9A-Z]{12,12}/ #DS2409
+          ['main','aux'].each do |side|
+            split = path.split("/")
+            split.delete("")
+            split += [dir,side]
+            newpath = "/"+split.join("/")
+            ret = find_recursive(serial,newpath,depth+1)
+            return ret if ret
+          end
+        end
+      end
+      nil
+    end
+  end
+
+  class RawConnection
+    # Connection without any of the hub discovery niceties
+
     def initialize(opts={})
       @server = opts[:server] || 'localhost'
       @port = opts[:port] || 4304
@@ -127,8 +187,11 @@ module OWNet
     def owconnect(&block)
       socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
       socket.connect(Socket.pack_sockaddr_in(@port, @server))
-      yield socket
-      socket.close
+      begin
+        yield socket
+      ensure
+        socket.close
+      end
     end
 
     public    

data/lib/ownet.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__)+'/connection.rb'
 
 module OWNet
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/ownet.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.name              = 'ownet'
-  s.version           = '0.1.0'
-  s.date              = '2010-12-29'
+  s.version           = '0.2.0'
+  s.date              = '2011-07-05'
 
   s.summary     = "Client to connect to one-wire devices through owserver of the OWFS project"
   s.description = "A simple client that interfaces with owserver from the owfs project"
@@ -33,6 +33,8 @@ Gem::Specification.new do |s|
     lib/ownet.rb
     ownet.gemspec
     test/connection_test.rb
+    test/mock_connection_test.rb
+    test/mock_owserver.rb
     test/test_helper.rb
   ]
   # = MANIFEST =

data/test/mock_connection_test.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class TestMockConnection < Test::Unit::TestCase
+  BASE_DIR = ["/1F.67C6697351FF", "/10.4AEC29CDBAAB", "/bus.0", "/uncached", 
+              "/settings", "/system", "/statistics", "/structure", 
+              "/simultaneous", "/alarm"]
+
+  def test_read
+    with_mock_owserver('/10.4AEC29CDBAAB/temperature'=>'22.35') do
+      c = OWNet::Connection.new
+      assert_equal 22.35, c.read("/10.4AEC29CDBAAB/temperature")
+    end
+  end
+  
+  def test_dir
+    with_mock_owserver('/'=>BASE_DIR) do
+      c = OWNet::Connection.new
+      assert_equal BASE_DIR, c.dir("/")
+    end
+  end
+
+  def test_write
+    with_mock_owserver do |server|
+      c = OWNet::Connection.new
+      assert_equal 0, c.write("/test","abc")  
+      assert_equal "abc", server.req_data
+    end
+  end
+
+  def test_ops_with_hub
+    fakedir = ["no_such_file","another"]
+    temperature = "/10.85EC3B020800"
+    humidity = "/26.CFD6F1000000"
+    hubs = ["/1F.A65A05000000", "/1F.365B05000000", "/1F.B15A05000000"]
+    paths = {'/'=>hubs}
+    channels = hubs.map{|hub| ['main','aux'].map {|suffix| hub+'/'+suffix}}.flatten
+    channels.each {|channel| paths[channel] = []}
+    paths[channels[0]] = [temperature,humidity].map{|suffix| channels[0]+suffix}
+    paths[channels[0]+temperature+'/temperature'] = '25'
+    paths[channels[0]+temperature] = fakedir
+    paths[channels[0]+humidity+'/humidity'] = '50'
+    paths[channels[0]+humidity] = fakedir
+    with_mock_owserver(paths) do |server|
+      ['','/uncached'].each do |prefix|
+        c = OWNet::Connection.new
+        server.nrequests = 0
+        assert_equal 25, c.read(prefix+temperature+"/temperature")
+        assert_reqs server, 4
+        server.nrequests = 0
+        assert_equal fakedir, c.dir(prefix+temperature)
+        assert_reqs server, 1
+        assert_equal 50, c.read(prefix+humidity+"/humidity")
+        assert_equal fakedir, c.dir(prefix+humidity)
+        assert_equal nil, c.read(prefix+"/no_such_path")
+        assert_equal [], c.dir(prefix+"/no_such_path")
+      end
+    end
+  end
+
+  def assert_reqs(server,reqs)
+    assert_equal reqs, server.nrequests, "Expecting to do #{reqs} requests but did #{server.nrequests}"
+  end
+
+  def test_recursive_stop_with_hub
+    hub = "/1F.A65A05000000"
+    paths = {}
+    (0..20).each do |i|
+      paths["/"+(hub+"/main")*i] = [(hub+"/main")*i+"/"+hub]
+      paths["/"+(hub+"/aux")*i] = [(hub+"/aux")*i+"/"+hub]
+    end
+    with_mock_owserver(paths) do |server|
+      c = OWNet::Connection.new
+      assert_equal nil, c.read("/10.85EC3B020800/temperature")
+      assert_reqs server, 20
+    end
+  end
+end

data/test/mock_owserver.rb

@@ -0,0 +1,160 @@
+require 'socket'
+require 'thread'
+
+module MockOWServer
+  ERROR = 0
+  NOP = 1
+  READ = 2
+  WRITE = 3
+  DIR = 4
+  SIZE = 5
+  PRESENCE = 6
+
+  # Exception raised when there's a short read from the client
+  class ClientShortRead < RuntimeError  
+    def to_s
+      "Short read communicating with owserver"
+    end
+  end
+
+  # Encapsulates a request to the server
+  class Request
+    attr_accessor :function, :path, :data, :flags
+    
+    def initialize(socket)
+      data = socket.read(24)
+      raise ClientShortRead if !data || data.size != 24
+      zero, payload_len, self.function, self.flags, data_len, zero = data.unpack('NNNNNN')
+      if payload_len > 0
+        payload = socket.read(payload_len)
+        raise ClientShortRead if !payload || payload.size != payload_len
+        if self.function == WRITE
+          self.path = payload[0..-(data_len+2)]
+          self.data = payload[-(data_len+1)..-2]
+        else
+          self.path = payload[0..-2]
+        end
+      end
+    end
+  end
+  
+  # Encapsulates a response from owserver
+  class Response    
+    attr_accessor :data, :return_value, :flags
+
+    def initialize(opts={})
+      opts.each {|name, value| self.send(name.to_s+'=', value)}
+      @return_value ||= 0
+      @flags ||= 258
+    end
+
+    def header
+      data_len = (@data ? @data.size : 0)
+      payload_len = (@data ? @data.size+1 : 0)
+      [0, payload_len, self.return_value, self.flags, data_len, 0].pack('NNNNNN')
+    end
+
+    def write(socket)
+      socket.write(header)
+      socket.write(data + "\000") if @data
+    end
+  end
+
+  class Server
+    attr_accessor :paths
+
+    def req_path
+      @mutex.synchronize do
+        @req_path
+      end
+    end
+
+    def req_data
+      @mutex.synchronize do
+        @req_data
+      end
+    end
+
+    def nrequests
+      @mutex.synchronize do
+        @nrequests
+      end
+    end
+
+    def nrequests=(value)
+      @mutex.synchronize do
+        @nrequests=value
+      end
+    end
+
+    def initialize(opts={})
+      @address = opts[:address] || 'localhost'
+      @port = opts[:port] || 4304
+      paths = opts[:paths] || {}
+      @paths = {}
+      paths.each do |k,v| 
+        canon = canonical_path(k)
+        @paths[canon] = v
+        @paths[canonical_path("uncached/"+canon)] = v
+      end
+      @mutex = Mutex.new
+    end
+
+    def run!
+      @stopped = false
+      @nrequests = 0
+      @thread = Thread.new do
+        socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+        socket.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
+        socket.bind(Socket.pack_sockaddr_in(@port, @address))
+        socket.listen 10
+        while !@stopped
+          begin
+            client, client_sockaddr = socket.accept_nonblock
+            respond(client)
+          rescue Errno::EAGAIN
+            sleep 0.1
+          end
+        end
+        socket.close
+      end
+    end
+
+    def respond(client)
+      @mutex.synchronize do
+        req = Request.new(client)
+        @req_path = req.path
+        @req_data = req.data
+        @nrequests += 1
+        if req.path[0..1] == '//'
+          $stderr.puts "Double slash path asked for: #{req.path}" 
+          Response.new.write(client)
+        else
+          case req.function
+          when READ
+            Response.new(:data => @paths[canonical_path(req.path)]).write(client)
+          when DIR
+            (@paths[canonical_path(req.path)]||[]).each do |dir|
+              Response.new(:data => dir).write(client)
+            end
+            Response.new.write(client)
+          when WRITE
+            Response.new.write(client)
+          end
+        end
+      end
+    end
+
+    def stop! 
+      @stopped = true
+      @thread.join
+    end
+
+    private
+    def canonical_path(path)
+      split = path.split("/")
+      split.delete("")
+      split.join("/")
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 require 'yaml'
 require 'fileutils'
+require File.dirname(__FILE__)+'/mock_owserver'
 require File.dirname(__FILE__)+'/../lib/ownet.rb'
 
 class Test::Unit::TestCase  
@@ -16,4 +17,13 @@ class Test::Unit::TestCase
     Process.kill("TERM", pid)
     Process.waitpid(pid)
   end
+  def with_mock_owserver(paths=nil)
+    server = MockOWServer::Server.new(:paths => paths)
+    server.run!
+    begin
+      yield server
+    ensure
+      server.stop!
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ownet
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Pedro C\xC3\xB4rte-Real"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-29 00:00:00 +00:00
+date: 2011-07-05 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,8 @@ files:
 - lib/ownet.rb
 - ownet.gemspec
 - test/connection_test.rb
+- test/mock_connection_test.rb
+- test/mock_owserver.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: https://github.com/pedrocr/ownet
@@ -78,4 +80,6 @@ specification_version: 2
 summary: Client to connect to one-wire devices through owserver of the OWFS project
 test_files: 
 - test/connection_test.rb
+- test/mock_connection_test.rb
+- test/mock_owserver.rb
 - test/test_helper.rb