david 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf99b7a04f88ad84fc39ae748528fc0555d340a4
-  data.tar.gz: db0a00feed99717987b4b5e72e399e0c85d2accb
+  metadata.gz: b97cbebfb17845f2a5fa678fa026b40c2a843c40
+  data.tar.gz: 8cee683c847e3ea1f1a93a501904dcdcb7be2312
 SHA512:
-  metadata.gz: 17f584e9e2d9f2000a20eb0a22a963b42b8b4e82b9438c99e46d04be2e37c7670e35d739bd13850c45426a7c7e83837b74f266a76f4e30d117dc52a59ed08f9b
-  data.tar.gz: ca6cc59e8fedfa63392b6b8edbbf15076a0809e11433b9dcdeaf80d212ba696ddd0a0bc0ee7d5dc4e593ce22b3e16d7ab3574d7970ece21a6ca932379724cbc6
+  metadata.gz: 43be48293b3b0c45eabfe106aadbb6dc120db4224d01b09d752dedddb7525e22f03289b1497d28aa5e3c2c5a0a6ea614e9f433df1789b14bda8c5183b904fa1b
+  data.tar.gz: fa3af2ac69c7a12c4f9d67c70c0f261ef4a7dc3a216e4b6054f719233b45d30877335679baaf664a1f3e4eee80cce67fd943871f2d33d5090d49b57963f94349

data/.gitignore

@@ -1 +1,5 @@
 *.log
+spec/dummy/db/*.sqlite3
+coverage
+benchmarks/coapbench
+benchmarks/coapbench\(*

data/.travis.yml

@@ -7,14 +7,14 @@ os:
 rvm:
   - 2.2
   - jruby
-  - rbx-head
+  - rbx
 
 matrix:
   fast_finish: true
   allow_failures:
     - os: osx
     - rvm: jruby
-    - rvm: rbx-head
+    - rvm: rbx
 
 notifications:
   email: false

data/Gemfile

@@ -7,10 +7,16 @@ group :cbor do
 end
 
 group :development do
-  gem 'sqlite3', platforms: :ruby
-  gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+  gem 'ruby-prof', platforms: :mri
 end
 
 group :test do
   gem 'coveralls', require: false
+
+  gem 'grape'
+  gem 'hobbit'
+  gem 'nyny'
+  gem 'rails', '~> 4.2.0'
+  gem 'rspec-rails', '~> 3.2.0'
+  gem 'sinatra'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    david (0.3.0.pre)
+    david (0.4.0)
       celluloid-io (~> 0.16, >= 0.16.1)
       coap (~> 0.1)
       rack (~> 1.5)
@@ -38,11 +38,6 @@ GEM
       activemodel (= 4.2.0)
       activesupport (= 4.2.0)
       arel (~> 6.0)
-    activerecord-jdbc-adapter (1.3.13)
-      activerecord (>= 2.2)
-    activerecord-jdbcsqlite3-adapter (1.3.13)
-      activerecord-jdbc-adapter (~> 1.3.13)
-      jdbc-sqlite3 (>= 3.7.2, < 3.9)
     activesupport (4.2.0)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
@@ -50,32 +45,54 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     arel (6.0.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.2)
     cbor (0.5.9.0)
     celluloid (0.16.0)
       timers (~> 4.0.0)
-    celluloid-io (0.16.1)
+    celluloid-io (0.16.2)
       celluloid (>= 0.16.0)
-      nio4r (>= 1.0.0)
-    coap (0.1.0)
+      nio4r (>= 1.1.0)
+    coap (0.1.1)
       celluloid-io (~> 0.16, >= 0.16.1)
       resolv-ipv6favor (~> 0)
-    coveralls (0.7.1)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    coveralls (0.7.9)
+      multi_json (~> 1.10)
+      rest-client (~> 1.7)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    equalizer (0.0.9)
     erubis (2.7.0)
     globalid (0.3.0)
       activesupport (>= 4.1.0)
+    grape (0.10.1)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    hashie (3.4.0)
     hike (1.2.3)
     hitimes (1.2.2)
     hitimes (1.2.2-java)
+    hobbit (0.6.0)
+      rack
     i18n (0.7.0)
-    jdbc-sqlite3 (3.8.7)
+    ice_nine (0.11.1)
     json (1.8.2)
     json (1.8.2-java)
     loofah (2.0.1)
@@ -86,13 +103,23 @@ GEM
     mini_portile (0.6.2)
     minitest (5.5.1)
     multi_json (1.10.1)
+    multi_xml (0.5.5)
     netrc (0.10.2)
     nio4r (1.1.0)
     nio4r (1.1.0-java)
-    nokogiri (1.6.5)
+    nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
-    nokogiri (1.6.5-java)
+    nokogiri (1.6.6.2-java)
+    nyny (2.2.1)
+      rack
+      tilt
     rack (1.6.0)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-protection (1.5.3)
+      rack
     rack-test (0.6.3)
       rack (>= 1.0)
     rails (4.2.0)
@@ -124,41 +151,46 @@ GEM
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-rails (3.1.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.0)
+      actionpack (>= 3.0, <= 4.2)
+      activesupport (>= 3.0, <= 4.2)
+      railties (>= 3.0, <= 4.2)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.0)
+    ruby-prof (0.15.3)
     simplecov (0.9.1)
       docile (~> 1.1.0)
       multi_json (~> 1.0)
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
     sprockets (2.12.3)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.2.2)
+    sprockets-rails (2.2.4)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
-    sqlite3 (1.3.10)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
@@ -167,21 +199,29 @@ GEM
     tilt (1.4.1)
     timers (4.0.1)
       hitimes
-    tins (1.3.3)
+    tins (1.3.4)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    virtus (1.0.4)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  activerecord-jdbcsqlite3-adapter
   cbor
   coveralls
   david!
-  rails (~> 4.2)
+  grape
+  hobbit
+  nyny
+  rails (~> 4.2.0)
   rake
   rspec (~> 3.1)
-  rspec-rails (~> 3.1)
-  sqlite3
+  rspec-rails (~> 3.2.0)
+  ruby-prof
+  sinatra

data/README.md

@@ -1,18 +1,100 @@
+# David
+
 [![Gem Version](https://img.shields.io/gem/v/david.svg)](http://badge.fury.io/rb/david)
 [![Dependency Status](https://img.shields.io/gemnasium/nning/david.svg)](https://gemnasium.com/nning/david)
 [![Build Status](https://img.shields.io/travis/nning/david.svg)](https://travis-ci.org/nning/david)
 [![Coverage Status](https://img.shields.io/coveralls/nning/david.svg)](https://coveralls.io/r/nning/david)
 [![Code Climate](https://img.shields.io/codeclimate/github/nning/david.svg)](https://codeclimate.com/github/nning/david)
 
-# 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 on not ready for use in production.**
+in a development state and probably not ready for use in production.**
+
+## Usage
+
+Just include David in your Gemfile!
+
+    gem 'david'
+
+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`.
+
+As [CoAP](https://tools.ietf.org/html/rfc7252) is a protocol for constrained
+environments and machine to machine communications, returning HTML from your
+controllers will not be of much use. JSON for example is more suitable in that
+context. You can also utilize [JBuilder
+templates](https://github.com/rails/jbuilder) for easy JSON generation.
+
+[CBOR](https://tools.ietf.org/html/rfc7049) can be used to compress your JSON.
+You can activate automatic transcoding between JSON and CBOR by setting the
+Rack environment option `CBOR` or `config.coap.cbor` in your Rails application
+config to `true`.
+
+## Tested Rack Frameworks
+
+* [Grape](https://github.com/intridea/grape)
+* [Hobbit](https://github.com/patriciomacadden/hobbit)
+* [NYNY](https://github.com/alisnic/nyny)
+* Plain Rack
+* [Sinatra](https://github.com/sinatra/sinatra)
+* [Rails](https://github.com/rails/rails)
+
+## Configuration
+
+| Rack key			| Rails key					| Default	| Semantics							|
+|---				|---						|---		|---								|
+| Block				| coap.block				| true		| Blockwise transfers				|
+| CBOR				| coap.cbor					| false		| JSON/CBOR transcoding				|
+| DefaultFormat		| coap.default_format		|			| Default Content-Type				|
+| Host				|							| ::1 / ::	| Server listening host				|
+| Log				|							| info		| Log level (none or debug)			|
+| MinimalMapping	|							| false		| Minimal HTTP status codes mapping	|
+| Multicast			| coap.multicast			| true		| Multicast support					|
+| Observe			| coap.observe				| true		| Observe support					|
+|					| coap.only					| true		| Removes (HTTP) middleware			|
+| Port				|							| 5683		| Server listening port				|
+|					| coap.resource_discovery	| true		| Provision of `.well-known/core`	|
+
+## Discovery
+
+The [CoAP Discovery](https://tools.ietf.org/html/rfc7252#section-7) will be
+activated by default. A `.well-known/core` resource automatically returns the
+resources you defined in Rails. You can annotate this resources with attributes
+like an interface description (`if`) or the content type (`ct`). (See
+[RFC6690](https://tools.ietf.org/html/rfc6690) or [the
+code](https://github.com/nning/coap/blob/master/lib/core/link.rb#L8) for
+further documentation.)
+
+    class ThingsController < ApplicationController
+      discoverable \
+        default: { if: 'urn:things', ct: 'application/cbor' },
+        index:   { if: 'urn:index' }
+
+      def show
+        render json: Thing.find(params[:id])
+      end
+
+      def index
+        render json: Thing.all
+      end
+	end
+
+## Rack environment
+
+| Key				| Value class	| Semantics |
+|---				|---			|--- |
+| coap.version		| Integer		| Protocol version of CoAP request |
+| coap.multicast	| Boolean		| Marks whether request was received via multicast |
+| coap.dtls			| String		| DTLS mode (as defined in [section 9 of RFC7252](https://tools.ietf.org/html/rfc7252#section-9)) |
+| coap.dtls.id		| String		| DTLS identity |
+| coap.cbor			| Object		| Ruby object deserialized from CBOR |
 
-A fork of the CoAP gem on rubygems.org is needed:
+## Benchmarks
 
-https://github.com/nning/coap
+David handles about 10.000 requests per second (tested in MRI 2.2.0 with up to
+10.000 concurrent clients on a single core of a Core i7-3520M CPU running Linux
+3.18.5).
 
 ## Copyright
 

data/benchmarks/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 gem 'benchmark-ips'
 gem 'coap', path: '../../coap'
+gem 'rack'

data/benchmarks/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../coap
   specs:
-    coap (0.0.17.dev)
+    coap (0.1.0)
       celluloid-io (~> 0.16, >= 0.16.1)
       resolv-ipv6favor (~> 0)
 
@@ -18,6 +18,7 @@ GEM
     hitimes (1.2.2-java)
     nio4r (1.1.0)
     nio4r (1.1.0-java)
+    rack (1.6.0)
     resolv-ipv6favor (0.0.0)
     timers (4.0.1)
       hitimes
@@ -29,3 +30,4 @@ PLATFORMS
 DEPENDENCIES
   benchmark-ips
   coap!
+  rack

data/benchmarks/coapbench.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+[ ! -d coapbench ] && {
+	mkdir -p coapbench
+	cd coapbench
+
+	git clone https://github.com/eclipse/californium.git
+	cd californium
+	mvn clean install
+	cd -
+
+	git clone https://github.com/eclipse/californium.tools.git
+	cd californium.tools
+	mvn clean install
+	cd -
+
+	cd ..
+}
+
+java -jar coapbench/californium.tools/run/cf-coapbench-*.jar $@

data/benchmarks/quick.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+./coapbench.sh -c 1000 -t 15 "coap://[::1]:5683/hello"

data/benchmarks/rackup/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'david', path: '../..'
+gem 'rack'
+
+# Rails
+gem 'rails', '~> 4.2.0'
+
+# Grape
+gem 'grape'

data/benchmarks/rackup/Gemfile.lock

@@ -0,0 +1,159 @@
+PATH
+  remote: ../..
+  specs:
+    david (0.4.0.pre)
+      celluloid-io (~> 0.16, >= 0.16.1)
+      coap (~> 0.1)
+      rack (~> 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    celluloid-io (0.16.2)
+      celluloid (>= 0.16.0)
+      nio4r (>= 1.1.0)
+    coap (0.1.0)
+      celluloid-io (~> 0.16, >= 0.16.1)
+      resolv-ipv6favor (~> 0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.9)
+    erubis (2.7.0)
+    globalid (0.3.0)
+      activesupport (>= 4.1.0)
+    grape (0.10.1)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    hashie (3.4.0)
+    hike (1.2.3)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.2)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    nio4r (1.1.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.0)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.5)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    resolv-ipv6favor (0.0.0)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    virtus (1.0.4)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  david!
+  grape
+  rack
+  rails (~> 4.2.0)