https://github.com/reednj/udp_rest

Client and server modules to allow making REST HTTP requests over UDP
https://github.com/reednj/udp_rest

http rest ruby udp

Last synced: 7 months ago
JSON representation

Client and server modules to allow making REST HTTP requests over UDP

• Host: GitHub
• URL: https://github.com/reednj/udp_rest
• Owner: reednj
• License: mit
• Created: 2016-12-02T00:58:05.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-14T06:27:32.000Z (over 8 years ago)
• Last Synced: 2025-06-05T11:36:35.190Z (8 months ago)
• Topics: http, rest, ruby, udp
• Language: Ruby
• Homepage: https://rubygems.org/gems/udp_rest
• Size: 53.7 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# REST over UDP

REST is a useful pattern for client-server interaction, but for simple scenarios setting up an entire HTTP stack is overkill. This gem provides a classes to allow for REST over UDP using a http-like protocol, as well as a curl like app for making requests from the command line.

The request and response size is limited 512 bytes, so this model is only appropriate for certain uses. Obviously it isn't very good for returning large amounts of data, but rather for sending commands to an endpoint, or logging small amounts of data with a high frequency.

## Try it out

There is a udp rest server running on uhttp.reednj.com, port 7890.

	gem install udp_rest

	udp-rest uhttp.reednj.com:7890

![terminal](docs/term.png)

Some other urls to try are:

 - uhttp.reednj.com:7890/time/iso

 - uhttp.reednj.com:7890/time/unix

 - uhttp.reednj.com:7890/count

## Client

Use the `UDPRest::Client` class to make requests programmatically

	UDPRest::Client.get('uhttp://uhttp.reednj.com:7890')

	UDPRest::Client.post('uhttp://uhttp.reednj.com:7890')

## Server

Use the `UDPRest::Server` class to create simple sinatra-style servers

	UDPRest::Server.new(:port => 7890) do |s|

		s.get '/' do

			'hello, world!'

		end

		s.get '/time' do

			Time.now.to_s

		end

		s.get '/echo' do |request|

			params['data'].to_s

		end

	end

## Performance

The performance difference can be quite signficant when making requests with poor latency - for example a request from Australia to the US takes about 900ms with http, and 300 - 400ms with udp_rest.