coap 0.0.16 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ea95430043e3d9721078d8f6dd68118c3d6ad50
-  data.tar.gz: 92df4bf71ded328e1377b93c9ca76662b739433f
+  metadata.gz: 56fd9991ac9ab886355fcce10739897c5ead898c
+  data.tar.gz: 53cf80a9babac55dd80aebe62741be8d13b3b1f4
 SHA512:
-  metadata.gz: 28be7a9f4417b5be3e458cc422e8b618b019dfc5f5e827016d166dfdd95abf90ebc2d0dd5751dff0f5757a3b0a472cabc10d270e1b2309ad4974748e0533c92a
-  data.tar.gz: a9032afb549e9f1632fdaafa2f4143834397da3dcc1b6ae4d1948e7c638984e06cd7908175ecd6e01fda606fddabd782a2db99824137b1cdc25b741732f408ac
+  metadata.gz: 01be6617acec7d215ddf15fdd34e443f6114f6677d5d2de3292298bd7e28c30c90f5a97f66f7aa3b08fd2d4853c3451f0159b41ef09ae1d675fcaa43727006ad
+  data.tar.gz: be1e122636bf35da1cd884cfaa663bd48539879b8607a96de3c53190045e10307193d84847048e981abe04f727cf621fb9041baa347d02856cbad004ece38ef0

data/.gitignore

@@ -32,3 +32,5 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+/Gemfile.lock

data/.travis.yml

@@ -1,5 +1,16 @@
 language: ruby
+
 rvm:
-  - 2.1.0
+  - 2.2
+  - jruby
+
+matrix:
+  allow_failures:
+    - rvm: jruby
+
+notifications:
+  email: false
+
 script:
-  - "bundle exec rake test"
+  - bundle exec rake build
+  - bundle exec rake coveralls

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in coap.gemspec
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Simon Frerichs, Carsten Bormann
+Copyright (c) 2014 Carsten Bormann, Simon Frerichs, henning mueller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/README.md

@@ -1,32 +1,31 @@
-[![Gem Version](https://badge.fury.io/rb/coap.png)](http://badge.fury.io/rb/coap)
-[![Dependency Status](https://gemnasium.com/SmallLars/coap.png)](https://gemnasium.com/SmallLars/coap)
-[![Build Status](https://travis-ci.org/SmallLars/coap.png?branch=master)](https://travis-ci.org/SmallLars/coap)
-[![Coverage Status](https://coveralls.io/repos/SmallLars/coap/badge.png?branch=master)](https://coveralls.io/r/SmallLars/coap)
-[![Code Climate](https://codeclimate.com/github/SmallLars/coap.png)](https://codeclimate.com/github/SmallLars/coap)
+[![Gem Version](https://img.shields.io/gem/v/coap.svg)](http://badge.fury.io/rb/coap)
+[![Dependency Status](https://img.shields.io/gemnasium/nning/coap.svg)](https://gemnasium.com/nning/coap)
+[![Build Status](https://img.shields.io/travis/nning/coap.svg)](https://travis-ci.org/nning/coap)
+[![Coverage Status](https://img.shields.io/coveralls/nning/coap.svg)](https://coveralls.io/r/nning/coap)
+[![Code Climate](https://img.shields.io/codeclimate/github/nning/coap.svg)](https://codeclimate.com/github/nning/coap)
 
-# Gem CoAP
+# CoAP
 
-Ruby Gem for RFC 7252 - Constrained Application Protocol (CoAP)<br>
-Based on code by Carsten Bormann<br>
+This Ruby gem implements client functionality for [RFC
+7252](http://tools.ietf.org/html/rfc7252), the Constrained Application Protocol
+(CoAP). The message parsing code included is written by Carsten Bormann, one of
+the RFC authors.
 
-The Constrained Application Protocol (CoAP) is a specialized web
-transfer protocol for use with constrained nodes and constrained
-(e.g., low-power, lossy) networks.  The nodes often have 8-bit
-microcontrollers with small amounts of ROM and RAM, while constrained
-networks such as 6LoWPAN often have high packet error rates and a
-typical throughput of 10s of kbit/s.  The protocol is designed for
-machine-to-machine (M2M) applications such as smart energy and
-building automation.<br>
+The Constrained Application Protocol (CoAP) is a specialized web transfer
+protocol for use with constrained nodes and constrained (e.g., low-power,
+lossy) networks.  The nodes often have 8-bit microcontrollers with small
+amounts of ROM and RAM, while constrained networks such as 6LoWPAN often have
+high packet error rates and a typical throughput of 10s of kbit/s.  The
+protocol is designed for machine-to-machine (M2M) applications such as smart
+energy and building automation.
 
+Additionally supported extensions of the CoAP protocol:
 
-Implemented Version: RFC (http://tools.ietf.org/html/rfc7252)<br>
-
-Additionally implemented:
-
- - Blockwise Transfer http://tools.ietf.org/html/draft-ietf-core-block-14
- - Observe http://tools.ietf.org/html/draft-ietf-core-observe-13
+* [Blockwise Transfer](http://tools.ietf.org/html/draft-ietf-core-block-14)
+* [Observe](http://tools.ietf.org/html/draft-ietf-core-observe-13)
 
 ## Install
+
 Add this line to your application's Gemfile:
 
     gem 'coap'
@@ -41,24 +40,29 @@ Or install it yourself as:
 
 ## Usage
 
-### In your ruby/rails application
+### In your Ruby (on Rails) application
 
+	require 'coap'
+    CoAP::Client.new.get_by_uri('coap://coap.me/hello').payload
 
-    client = CoAP::Client.new
-    answer = client.get('coap.me', 5683, '/hello')
-    p answer.payload
+See `test/test_client.rb` for more examples.
 
-Lot's of examples are stored in test/test_client.rb<br>
-Code is commented in rdoc format
+### Command Line Client
 
-### Command Line Client (very limited)
+The command line client supports the basic CoAP methods.
 
-    ./client get coap://coap.me:5683/.well-known/core
+    coap get coap://coap.me/.well-known/core
 
 ## Testing
 
-    rake test
+    rake
 
 ## Copyright
-Copyright (C) 2014 Simon Frerichs. See LICENSE.txt for further details.<br>
-Based on code by Carsten Bormann
+
+The code is published under the MIT license (see the LICENSE file).
+
+### Authors
+
+* Carsten Bormann
+* Simon Frerichs
+* [henning mueller](https://henning.orgizm.net)

data/Rakefile

@@ -1,9 +1,18 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'coveralls/rake/task'
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+Coveralls::RakeTask.new
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
 end
 
-desc "Run tests"
-task :default => :test
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run tests.'
+task default: [:spec, :test]
+
+desc 'Tun tests and push coverage to coveralls.'
+task coveralls: [:default, 'coveralls:push']

data/bin/coap

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+
+require 'getoptlong'
+require 'pp'
+require 'uri'
+
+$:.unshift File.expand_path('../lib', File.dirname(__FILE__))
+require 'coap'
+
+def usage
+  $stderr.puts <<EOF
+Usage: #{File.basename($0)} [options] <method> <uri>
+
+  --debug, -d                   Extra debug output.
+  --output, -o        <target>  Redirect payload output. Target can be "-" for
+                                STDOUT or a file path.
+  --payload, -p       <string>  Payload for POST and PUT as string.
+  --payload-file, -f  <file>    Read payload for POST and PUT from file.
+  --type, -t          <type>    Message type (con, non, ack, rst).
+  --help, -h                    This usage message.
+
+EOF
+  exit 1
+end
+
+METHODS = CoAP::METHODS + [:observe]
+
+opts = GetoptLong.new(
+  ['--debug',        '-d', GetoptLong::NO_ARGUMENT],
+  ['--output',       '-o', GetoptLong::REQUIRED_ARGUMENT],
+  ['--payload',      '-p', GetoptLong::REQUIRED_ARGUMENT],
+  ['--payload-file', '-f', GetoptLong::REQUIRED_ARGUMENT],
+  ['--type',         '-t', GetoptLong::REQUIRED_ARGUMENT],
+  ['--help',         '-h', GetoptLong::NO_ARGUMENT]
+)
+
+$DEBUG  = false
+output  = nil
+payload = nil
+options = {}
+
+opts.each do |opt, arg|
+  case opt
+  when '--debug'
+    $DEBUG = true
+  when '--output'
+    if arg == '-'
+      output = $stdout
+    else
+      output = File.open(arg, 'w')
+    end
+  when '--payload'
+    payload = arg
+  when '--payload-file'
+    payload = File.read(arg)
+  when '--type'
+    options[:tt] = arg.to_sym
+  when '--help'
+    usage
+  end
+end
+
+usage if ARGV.size != 2
+
+method = ARGV.shift
+uri    = ARGV.shift
+
+method = method.to_sym
+usage unless METHODS.include? method
+
+uri = 'coap://' + uri unless uri[/^coap[s]?:\/\//]
+uri = URI.parse(uri)
+
+usage unless uri.scheme[/^coap/]
+
+client = CoAP::Client.new
+
+answer = case method
+when :get
+  client.get_by_uri(uri, payload, options)
+
+when :post
+  client.post_by_uri(uri, payload, options)
+
+when :put
+  client.put_by_uri(uri, payload, options)
+
+when :delete
+  client.delete_by_uri(uri, payload, options)
+
+when :observe
+  callback = ->(socket, message) do
+    if output
+      output.puts message.payload
+    else
+      pp message
+    end
+  end
+
+  begin
+    client.observe_by_uri(uri, callback)
+  rescue Interrupt
+    exit
+  end
+end
+
+if output
+  output.puts answer.payload
+else
+  pp answer
+end

data/coap.gemspec

@@ -1,33 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coap/version'
+$:.unshift File.expand_path('lib', File.dirname(__FILE__))
+require 'core/coap/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "coap"
-  spec.version       = Coap::VERSION
-  spec.authors       = ["Carsten Bormann","Simon Frerichs"]
-  spec.email         = ["morpheus@morphhome.net"]
-  spec.summary       = %q{Ruby Gem for RFC 7252 - Constrained Application Protocol (CoAP)}
-  spec.description   = %q{Ruby Gem for RFC 7252 - Constrained Application Protocol (CoAP)
-The Constrained Application Protocol (CoAP) is a specialized web
-transfer protocol for use with constrained nodes and constrained
-(e.g., low-power, lossy) networks.  The nodes often have 8-bit
-microcontrollers with small amounts of ROM and RAM, while constrained
-networks such as 6LoWPAN often have high packet error rates and a
-typical throughput of 10s of kbit/s.  The protocol is designed for
-machine-to-machine (M2M) applications such as smart energy and
-building automation}
-  spec.homepage      = "https://github.com/SmallLars/coap"
-  spec.license       = "MIT"
+Gem::Specification.new do |s|
+  s.name = 'coap'
+  s.version = CoRE::CoAP::VERSION
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  s.summary = 'Pure Ruby implementation of RFC 7252 (Constrained Application Protocol (CoAP))'
+  s.description = 'Pure Ruby implementation of RFC 7252 (Constrained Application
+    Protocol (CoAP)). The Constrained Application Protocol (CoAP) is a
+    specialized web transfer protocol for use with constrained nodes and
+    constrained (e.g., low-power, lossy) networks. The nodes often have 8-bit
+    microcontrollers with small amounts of ROM and RAM, while constrained
+    networks such as IPv6 over Low-Power Wireless Personal Area Networks
+    (6LoWPANs) often have high packet error rates and a typical throughput of
+    10s of kbit/s. The protocol is designed for machine-to-machine (M2M)
+    applications such as smart energy and building automation.'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_dependency "resolv-ipv6favor"
-#  spec.add_dependency "codtls"
+  s.homepage = 'https://github.com/nning/coap'
+  s.license  = 'MIT'
+  s.authors  = ['Carsten Bormann', 'Simon Frerichs', 'henning mueller']
+  s.email    = 'henning@orgizm.net'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler',   '~> 1.6'
+  s.add_development_dependency 'coveralls', '~> 0.7'
+  s.add_development_dependency 'faker',     '~> 1.4'
+  s.add_development_dependency 'minitest',  '~> 5.4'
+  s.add_development_dependency 'rake',      '~> 10.3'
+  s.add_development_dependency 'rspec',     '~> 3.0'
+
+  s.add_dependency 'celluloid-io', '~> 0.16', '>= 0.16.1'
+  s.add_dependency 'resolv-ipv6favor', '~> 0'
 end

data/lib/coap.rb

@@ -1,34 +1,3 @@
-# encoding: utf-8
-module CoAP
-  module_function
-
-  def logger
-    if @logger.nil?
-      @logger = Logger.new(STDOUT)
-      @logger.level = Logger::WARN
-    end
-
-    @logger
-  end
-  def logger= logger
-    @logger.close unless @logger.nil?
-    
-    @logger = logger
-  end
-end
-
-require 'logger'
-require 'socket'
-require 'resolv-ipv6favor'
-require 'ipaddr'
-require 'timeout'
-#require 'CoDTLS'
-
-require 'coap/coap.rb'
-require 'coap/message.rb'
-require 'coap/block.rb'
-require 'coap/mysocket.rb'
-require 'coap/observer.rb'
-require 'coap/client.rb'
-
-require 'misc/hexdump.rb'
+$:.unshift File.expand_path(File.dirname(__FILE__))
+require 'core'
+include CoRE

data/lib/core.rb

@@ -0,0 +1,11 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+module CoRE
+end
+
+require 'core/link'
+require 'core/coap'
+require 'core/hexdump'
+require 'core/os'
+
+require 'core/core_ext/socket'

data/lib/core/coap.rb

@@ -0,0 +1,42 @@
+module CoRE
+  module CoAP
+    module_function
+
+    def logger
+      if @logger.nil?
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::WARN
+      end
+
+      @logger
+    end
+
+    def logger=(logger)
+      @logger.close unless @logger.nil?
+      @logger = logger
+    end
+  end
+end
+
+require 'celluloid/io'
+require 'ipaddr'
+require 'logger'
+require 'resolv-ipv6favor'
+require 'socket'
+require 'timeout'
+require 'yaml'
+
+require 'core/coap/utility'
+require 'core/coap/coding'
+require 'core/coap/types'
+require 'core/coap/options'
+require 'core/coap/registry'
+
+require 'core/coap/coap'
+require 'core/coap/message'
+require 'core/coap/version'
+require 'core/coap/block'
+require 'core/coap/resolver'
+require 'core/coap/transmission'
+require 'core/coap/observer'
+require 'core/coap/client'