david 0.4.5 → 0.5.0

data/README.md

@@ -7,11 +7,10 @@
 [![Code Climate](https://img.shields.io/codeclimate/github/nning/david.svg)](https://codeclimate.com/github/nning/david)
 
 David is a CoAP server with Rack interface to bring the illustrious family of
-Rack compatible web frameworks into the Internet of Things. **Currently, it is
-in a development state and probably not ready for use in production.** It is
-tested with MRI >= 1.9, JRuby, and Rubinius.
+Rack compatible web frameworks into the Internet of Things. It is tested with
+MRI >= 1.9, JRuby, and Rubinius.
 
-## Usage
+## Quick Start
 
 Just include David in your Gemfile!
 
@@ -21,8 +20,21 @@ It will hook into Rack and make itself the default handler, so running `rails
 s` starts David. If you want to start WEBrick for example, you can do so by
 executing `rails s webrick`.
 
+**For now, you have to remove the `web-console` gem from the Gemfile (which is
+HTTP specific anyway) if you use Rails/David in CoAP only mode.** You probably
+also want to disable [CSRF
+protection](http://api.rubyonrails.org/classes/ActionController/RequestForgeryProtection/ClassMethods.html)
+by removing the `protect_from_forgery` line from
+`app/controllers/application_controller.rb` (or use `:null_session` if you know
+what you are doing).
+
+The [`coap-rails-dummy`](https://github.com/nning/coap-rails-dummy) repository
+documents [changes to a newly generated Ruby on Rails application for a quick
+start](https://github.com/nning/coap-rails-dummy/compare/initial...master).
+
 After the server is started, the Rails application is available at
-`coap://[::1]:3000/` by default.
+`coap://[::1]:3000/` by default. (Although you have to set a route for `/` in
+`config/routes.rb`, of course.)
 
 [Copper](https://addons.mozilla.org/de/firefox/addon/copper-270430/) is a CoAP
 client for Firefox and can be used for development. The [Ruby coap

data/david.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'celluloid',    '>= 0.16.0', '< 0.17'
-  s.add_runtime_dependency 'celluloid-io', '>= 0.16.1', '< 0.17'
-  s.add_runtime_dependency 'coap',         '>= 0.1'
-  s.add_runtime_dependency 'rack',         '~> 1.6'
+  s.add_runtime_dependency 'celluloid',    '~> 0.17.3'
+  s.add_runtime_dependency 'celluloid-io', '~> 0.17.3'
+  s.add_runtime_dependency 'coap',         '~> 0.1'
+  s.add_runtime_dependency 'rack',         '~> 2.0'
 
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake',  '~> 0'
   s.add_development_dependency 'rspec', '~> 3.2'
 end

data/lib/david.rb

@@ -13,9 +13,10 @@ unless defined?(JRuby)
   end
 end
 
-require 'celluloid'
+require 'celluloid/current'
 require 'celluloid/io'
 require 'coap'
+require 'forwardable'
 require 'ipaddr'
 require 'rack'
 

data/lib/david/etsi/mandatory/roda.rb

@@ -0,0 +1,36 @@
+module David::ETSI::Mandatory
+  class Roda < ::Roda
+    plugin :all_verbs
+    plugin :default_headers, 'Content-Type' => 'text/plain'
+
+    route do |r|
+      r.get 'test' do
+        response.status = 2.05
+      end
+      
+      r.post :test do
+        response.status = 2.01
+      end
+      
+      r.put :test do
+        response.status = 2.04
+      end
+      
+      r.delete :test do
+        response.status = 2.02
+      end
+
+      r.on 'seg1' do
+        r.on 'seg2' do
+          r.get 'seg3' do
+            response.status = 2.05
+          end
+        end
+      end
+
+      r.get 'query' do
+        response.status = 2.05
+      end
+    end
+  end
+end

data/lib/david/observe.rb

@@ -1,12 +1,15 @@
 module David
-  class Observe < Hash
+  class Observe
+    extend Forwardable
+
     include Actor
 
-    alias_method :_delete, :delete
-    alias_method :_include?, :include?
+    def_delegators :@store, :first, :keys, :size
 
     def initialize(tick_interval = 3)
       @tick_interval = tick_interval
+      @store = {}
+
       async.run
 
       log.debug('Observe initialized')
@@ -15,34 +18,38 @@ module David
     def add(exchange, env, etag)
       exchange.message.options.delete(:observe)
 
-      self[[exchange.host, exchange.token]] ||=
+      @store[[exchange.host, exchange.token]] ||=
         [0, exchange, env, etag, Time.now.to_i]
     end
 
     def delete(exchange)
-      _delete([exchange.host, exchange.token])
+      @store.delete([exchange.host, exchange.token])
+    end
+
+    def get(key)
+      @store[key]
     end
 
     def include?(exchange)
-      _include?([exchange.host, exchange.token])
+      @store.include?([exchange.host, exchange.token])
     end
 
     def to_s
-      self.map { |k, v| [*k, v[2]['PATH_INFO'], v[0]].inspect }.join(', ')
+      @store.map { |k, v| [*k, v[2]['PATH_INFO'], v[0]].inspect }.join(', ')
     end
 
     private
 
     def bump(key, n, response)
-      self[key][0] = n
-      self[key][3] = response.options[:etag]
-      self[key][4] = Time.now.to_i
+      @store[key][0] = n
+      @store[key][3] = response.options[:etag]
+      @store[key][4] = Time.now.to_i
     end
 
     # TODO If ETag did not change but max-age of last notification is expired,
     #      return empty 2.03.
     def handle_update(key)
-      n, exchange, env, etag = self[key]
+      n, exchange, env, etag = @store[key]
       n += 1
 
       response, options = server.respond(exchange, env)
@@ -86,12 +93,12 @@ module David
     end
 
     def tick(fiber = true)
-      unless self.empty?
+      unless @store.empty?
         log.debug('Observe tick')
-        log.debug(self)
+        log.debug(@store)
       end
 
-      self.each_key do |key|
+      @store.each_key do |key|
         if fiber
           async.handle_update(key)
         else

data/lib/david/railties/middleware.rb

@@ -7,6 +7,7 @@ module David
       UNWANTED = [
         ActionDispatch::Cookies,
         ActionDispatch::DebugExceptions,
+        ActionDispatch::Executor,
         ActionDispatch::Flash,
         ActionDispatch::RemoteIp,
         ActionDispatch::RequestId,

data/lib/david/registry.rb

@@ -17,7 +17,7 @@ module David
 
     def observe
       # Supervision is only initialized from here in tests.
-      Observe.supervise_as(:observe) if Celluloid::Actor[:observe].nil?
+      Observe.supervise(as: :observe) if Celluloid::Actor[:observe].nil?
       Celluloid::Actor[:observe]
     end
 

data/lib/david/resource_discovery_proxy.rb

@@ -3,7 +3,7 @@ require 'david/resource_discovery'
 module David
   class ResourceDiscoveryProxy
     def initialize(app)
-      ResourceDiscovery.supervise_as(:discovery, app)
+      ResourceDiscovery.supervise(as: :discovery, args: [app])
     end
 
     def call(env)

data/lib/david/server/multicast.rb

@@ -36,7 +36,7 @@ module David
 
         # http://lists.apple.com/archives/darwin-kernel/2014/Mar/msg00012.html
         if OS.osx?
-          ifname  = Socket.if_up?('en1') ? 'en1' : 'en0'
+          ifname  = `route get default`.match(/interface: ([a-z0-9]*)$/)[1]
           ifindex = Socket.if_nametoindex(ifname)
         end
 

data/lib/david/server/utility.rb

@@ -5,8 +5,9 @@ module David
 
       # This can only use each on body and currently does not support streaming.
       def body_to_string(body)
+        p body
         s = ''
-        body.each { |line| s << line << "\r\n" }
+        body.each { |line| s << line.to_s << "\r\n" }
         body.close if body.respond_to?(:close)
         s.chomp
       end

data/lib/david/version.rb

@@ -1,7 +1,7 @@
 module David
   MAJOR = 0
-  MINOR = 4
-  PATCH = 5
+  MINOR = 5
+  PATCH = 0
   SUFFIX = nil
 
   VERSION = [MAJOR, MINOR, PATCH, SUFFIX].compact.join('.')

data/lib/rack/handler/david.rb

@@ -2,13 +2,13 @@ module Rack
   module Handler
     class David
       def self.run(app, options={})
-        g = Celluloid::SupervisionGroup.run!
+        g = Celluloid::Supervision::Container.run!
 
-        g.supervise_as(:server, ::David::Server, app, options)
-        g.supervise_as(:gc, ::David::GarbageCollector)
+        g.supervise(as: :server, type: ::David::Server, args: [app, options])
+        g.supervise(as: :gc, type: ::David::GarbageCollector)
 
         unless options[:Observe] == 'false'
-          g.supervise_as(:observe, ::David::Observe)
+          g.supervise(as: :observe, type: ::David::Observe)
         end
 
         begin

data/spec/app_config_spec.rb

@@ -15,7 +15,8 @@ describe AppConfig do
     it { expect(method.call(nil)).to eq(nil) }
     it { expect(method.call('::')).to eq('::') }
     it { expect(method.call('::1')).to eq('::1') }
-    it { expect(method.call('localhost')).to eq('::1') }
+    it { expect(method.call('127.0.0.1')).to eq('127.0.0.1') }
+    it { expect(%w[::1 127.0.0.1]).to include(method.call('localhost')) }
   end
 
   describe '#choose_port' do

data/spec/dummy/app/controllers/etsis_controller.rb

@@ -1,7 +1,6 @@
 class EtsisController < ActionController::Base
   def show
-    headers['Content-Type'] = 'text/plain'
-    head 2.05
+    head 2.05, content_type: :text
   end
 
   def update

data/spec/dummy/app/controllers/tests_controller.rb

@@ -1,9 +1,9 @@
 class TestsController < ActionController::Base
   def benchmark
-    render text: 'Hello World!'
+    render plain: 'Hello World!'
   end
 
   def cbor
-    render text: params['test'].to_s
+    render plain: params['test'].to_json
   end
 end

data/spec/interop/mandatory_spec.rb

@@ -5,6 +5,7 @@ require 'spec_helper'
   ETSI::Mandatory::Hobbit,
   ETSI::Mandatory::NYNY,
   ETSI::Mandatory::Rack,
+  ETSI::Mandatory::Roda.freeze.app,
   ETSI::Mandatory::Sinatra,
   Rails.application
 ].each do |app|

data/spec/interop/optional_spec.rb

@@ -83,7 +83,7 @@ require 'spec_helper'
 
         @t1 = Thread.start do
           CoAP::Client.new.observe \
-            '/obs', '::1', port,
+            '/obs', localhost, port,
             ->(s, m) { @answers << m }
         end
 

data/spec/mapping_spec.rb

@@ -42,7 +42,7 @@ describe Server::Mapping do
 
       let!(:server) { supervised_server(:Port => port) }
 
-      subject { client.get('/code', '::1') }
+      subject { client.get('/code', localhost) }
 
       it 'should be 2.05' do
         expect(subject).to be_a(CoAP::Message)

data/spec/observe_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 Celluloid.logger = ENV['DEBUG'].nil? ? nil : Logger.new($stdout)
 
 describe Observe do
-  let!(:observe) { Observe.supervise_as(:observe) }
+  let!(:observe) { Observe.supervise(as: :observe) }
 
   # TODO Replace this with factory.
   before do
@@ -33,7 +33,7 @@ describe Observe do
     let!(:add) { subject.add(*dummy1) }
 
     let!(:key) { [dummy1[0].host, dummy1[0].token] }
-    let!(:value) { subject[key] }
+    let!(:value) { subject.get(key) }
 
     it '#to_s' do
       s = '["127.0.0.1", ' + dummy1[0].token.to_s + ', "/", 0]'
@@ -131,16 +131,16 @@ describe Observe do
     it 'shall change entry' do
       subject.send(:bump, key, n, response)
 
-      expect(subject[key][0]).to eq(n)
-      expect(subject[key][3]).to eq(response.options[:etag])
-      expect(subject[key][4]).to be <= Time.now.to_i
+      expect(subject.get(key)[0]).to eq(n)
+      expect(subject.get(key)[3]).to eq(response.options[:etag])
+      expect(subject.get(key)[4]).to be <= Time.now.to_i
     end
   end
 
   describe '#handle_update' do
     let(:port) { random_port }
 
-    let!(:server) { supervised_server(:Port => port) }
+    let!(:server) { supervised_server(:Host => '0.0.0.0', :Port => port) }
 
     context 'error (4.04)' do
       let!(:key) { [dummy1[0].host, dummy1[0].token] }
@@ -152,7 +152,7 @@ describe Observe do
       end
 
       it 'delete' do
-        expect(subject[key]).to eq(nil)
+        expect(subject.get(key)).to eq(nil)
       end
     end
 
@@ -166,9 +166,9 @@ describe Observe do
       end
 
       it 'bumped' do
-        expect(subject[key][0]).to eq(1)
-        expect(subject[key][3]).to eq(dummy2[0].message.options[:etag])
-        expect(subject[key][4]).to be <= Time.now.to_i
+        expect(subject.get(key)[0]).to eq(1)
+        expect(subject.get(key)[3]).to eq(dummy2[0].message.options[:etag])
+        expect(subject.get(key)[4]).to be <= Time.now.to_i
       end
     end
   end
@@ -176,7 +176,7 @@ describe Observe do
   describe '#tick' do
     let(:port) { random_port }
 
-    let!(:server) { supervised_server(:Port => port) }
+    let!(:server) { supervised_server(:Host => '0.0.0.0', :Port => port) }
 
     context 'update (2.05)' do
       let!(:key) { [dummy2[0].host, dummy2[0].token] }
@@ -188,9 +188,9 @@ describe Observe do
       end
 
       it 'bumped' do
-        expect(subject[key][0]).to eq(1)
-        expect(subject[key][3]).to eq(dummy2[0].message.options[:etag])
-        expect(subject[key][4]).to be <= Time.now.to_i
+        expect(subject.get(key)[0]).to eq(1)
+        expect(subject.get(key)[3]).to eq(dummy2[0].message.options[:etag])
+        expect(subject.get(key)[4]).to be <= Time.now.to_i
       end
     end
   end
@@ -208,7 +208,7 @@ describe Observe do
 
       @t1 = Thread.start do
         client.observe \
-          '/value', '::1', nil,
+          '/value', localhost, nil,
           ->(s, m) { @answers << m }
       end
 

data/spec/perf/server_perf_spec.rb

@@ -16,7 +16,7 @@ describe Server, 'performance', performance: true do
 
   # Stolen from thin.
   it "should handle GET request in less than #{max1 = 0.0045} seconds" do
-    expect(Benchmark.realtime { client.get('/', '::1') }).to be < max1
+    expect(Benchmark.realtime { client.get('/', localhost) }).to be < max1
   end
 
   after do

data/spec/resource_discovery_spec.rb

@@ -12,7 +12,7 @@ describe David::ResourceDiscovery do
   end
 
   context 'ordinary request' do
-    subject { client.get('/.well-known/core', '::1') }
+    subject { client.get('/.well-known/core', localhost) }
 
     context 'response' do
       let(:links) { CoRE::Link.parse_multiple(subject.payload) }
@@ -37,7 +37,7 @@ describe David::ResourceDiscovery do
   
   context 'filtered request' do
     context 'match' do
-      subject { client.get('/.well-known/core?href=new', '::1') }
+      subject { client.get('/.well-known/core?href=new', localhost) }
 
       context 'response' do
         let(:links) { CoRE::Link.parse_multiple(subject.payload) }
@@ -50,7 +50,7 @@ describe David::ResourceDiscovery do
     end
 
     context 'no match' do
-      subject { client.get('/.well-known/core?href=foo', '::1') }
+      subject { client.get('/.well-known/core?href=foo', localhost) }
 
       context 'response' do
         let(:links) { CoRE::Link.parse_multiple(subject.payload) }