udp_rest 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c547a1a4aeafe5240118f42f1d060b861bba377
-  data.tar.gz: 1f67cc942b89d5d8da7b12066d019b96eaa54cf1
+  metadata.gz: 904e404e65a334a0320065c54d102768c7a3e871
+  data.tar.gz: '07768180b9432171234523f242bbf6e755276a67'
 SHA512:
-  metadata.gz: 637dbc37f4e52a049b500f09aa60dcf167f27434fcfc9c2ea5c5fe8b442fc128e1d8cccf6b35c14ea42f3596c135cd1df3b03a1a5dea8f34f663dc8d56ebac33
-  data.tar.gz: e592fdfff3610df362d4a558d15bda20dde2b61302f4bafdb1ddbaebca62053291e71f101e349308ea8eb849725ae21e3cb6050ba5bcaaaa44fdb0b5d780ac0e
+  metadata.gz: 201b29a6818926a2a357902942ababb665ab2125740af71ef74cc90c9c317159f6fe1ae68a4111134f520881a32534144fab2941ccc89867ea9c725b54f190bc
+  data.tar.gz: 05ad627e079d76e0b505faab919aea4c33ae0fb16b92bae7c901e8612045950c63aa4e53569d8d1a114107f632b2157f65bd972dc1b9f3b41b4025d9addc5823

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    udp_rest (0.9.0)
+    udp_rest (0.9.2)
       colorize
       trollop
 
@@ -21,4 +21,4 @@ DEPENDENCIES
   udp_rest!
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/lib/udp_rest.rb

@@ -125,6 +125,7 @@ module UDPRest
 			req = UHTTPRequest.new
 			req.req_method = req_method
 			req.path = uri.path
+			req.query = uri.query
 
 			packet = client.send_text(req.to_s)
 			UHTTPResponse.parse(packet.text)

data/lib/udp_rest/uhttp.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'cgi'
 require 'socket'
 
 module UDPRest
@@ -6,6 +7,7 @@ module UDPRest
     class UDPRest::UHTTPRequest
         attr_accessor :req_method
         attr_accessor :path
+        attr_accessor :query
         attr_accessor :protocol
 
         def initialize
@@ -22,14 +24,38 @@ module UDPRest
             raise 'invalid request' if data.length != 3
             req = self.new
             req.req_method = data[0]
-            req.path = data[1]
             req.protocol = data[2]
+            
+            path_data = data[1].split('?')
+            req.path = path_data[0]
+            req.query = path_data[1] || '' if path_data.length > 1
+
             return req
         end
 
         def to_s
             self.path = '/' if path.nil? || path.empty?
-            "#{req_method} #{path} #{protocol}\n"
+            "#{req_method} #{path_and_query} #{protocol}\n"
+        end
+
+        def path_and_query
+            if query.nil? || query.strip == ''
+                path
+            else
+                path + '?' + query
+            end
+        end
+
+        def params
+            return {} if query.nil? || query.strip == ''
+
+            if @params.nil?
+                @params = {}
+                p = CGI.parse(self.query)
+                p.each {|k,v| @params[k] = v.first }
+            end
+
+            @params
         end
     end
 

data/lib/udp_rest/version.rb

@@ -1,3 +1,3 @@
 module UDPRest
-  VERSION = "0.9.0"
+  VERSION = "0.9.2"
 end

data/readme.md

@@ -1,35 +1,41 @@
 # REST over UDP
 
- - Most REST requets are very small
- - it should be possible to implement a simple version of HTTP that can run over UDP in order to make REST requets
- - we have implemented that
-  - the max packet size is 512 bytes
- - This gem makes it easy to create servers and clients for udp-rest
- - it also contains a curl-like command line app
- - obviously this is not going to work from any browser, but it can be useful for simple command line apps.
+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.
 
-## Try it out
+The request and response size is limited 512 bytes, so this model is only appropriate for certain apis. 
 
-There is a udp rest server running on uhttp.reednj.com. You can make requests to it by installing the gem.
+## Try it out
 
-		gem install udp_rest
-		udp-rest uhttp.reednj.com
+There is a udp rest server running on uhttp.reednj.com, port 7890.
 
-		<SCREEN SHOT OF CONSOLE>
+	gem install udp_rest
+	udp-rest uhttp.reednj.com:7890
 
-## Server
+![terminal](docs/term.png)
 
-Use this gem to create sinatra style servers to respond to requests.
+Some other urls to try are:
 
-		<CODE>
+ - uhttp.reednj.com:7890/time/iso
+ - uhttp.reednj.com:7890/time/unix
+ - uhttp.reednj.com:7890/count
 
 ## Client
 
-## Benchmarks
+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
 
- - do some testing of the latency here, see if it really is faster. Pick a few different servers
+Use the `UDPRest::Server` class to create simple sinatra-style servers
 
-## Other Points
+	UDPRest::Server.new(:port => 7890) do |s|
+		s.get '/'
+			'hello, world!'
+		end
 
- - encoding is always UTF-8
- - the max request and response size is 512 bytes
+		s.get '/time'
+			Time.now.to_s
+		end
+	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: udp_rest
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Nathan Reed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - bin/console
 - bin/setup
 - demo/simple_server.rb
+- docs/term.png
 - exe/udp-rest
 - lib/rest_client.rb
 - lib/udp_rest.rb