segregate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7421d31435304199cb1032dbe326420d13a75a69
-  data.tar.gz: eea29b9926c873d0c66a2bbf6a9106aa847b2e5c
+  metadata.gz: 00c26832bb6ab7be4cb90fcdc05c33619b9e1a46
+  data.tar.gz: c26a45764b6b70156f3dc1abf8ab05bd2661807a
 SHA512:
-  metadata.gz: 6d52b0c763d8705420c29d53722c70b74f84549fb5fafc426a4fb303b6057cd39b71b96904e413485027d226cf8d93840e0bde29469a8699efe609684576eb41
-  data.tar.gz: bdc263d1000ecaca777f3a808fb4c3e0ee6cbd3d93d87f3f2a0692611ba4a2e5312d2faf7336b3a7c5ff9ff0a092199602c54085f9573294b9661cc7b0cbac95
+  metadata.gz: dbd93e8b75a52fa3a59cc50e2745cc30f1ff2d7a494a37c87e8b306ead379f98341645f2cc64c9f46c5b3de35cfa42a24f4e528ace9b9043f0a294440256fd3e
+  data.tar.gz: 69d129517e6220d11686e0a1447f6c678a1056d0a60c5923964c465b48050ea64382b2aad00d0af00f5ba03060e9e754dd733164510189cc5351bb624a98deed

data/README.md

@@ -1,5 +1,4 @@
-Segregate
-=========
+## "Data is a precious thing and will last longer than the systems themselves."
 
 [![Code Climate](https://codeclimate.com/github/benSlaughter/segregate.png)](https://codeclimate.com/github/benSlaughter/segregate)
 [![Build Status](https://travis-ci.org/benSlaughter/segregate.png?branch=master)](https://travis-ci.org/benSlaughter/segregate)
@@ -8,3 +7,129 @@ Segregate
 [![Gem Version](https://badge.fury.io/rb/segregate.png)](http://badge.fury.io/rb/segregate)
 
 An http parser that also includes URI parsing and retaining and rebuilding the original data
+
+---------
+
+Segregate is an easy to use http parser, including object callback and the ability to rebuild the http message.
+
+Segregate is designed so that it is not only incredibly easy to parse incoming data in any state, and uses URI to parse the request line path. There is also the ability to be able to manipulate and change the data and reform the message into data that can then be reused or forwarded.
+
+### Limitations
+Currently the parser is unable to handle multiple headers with the same key.
+
+## Setup
+Segregate has been tested with Ruby 1.9.2 and later.
+To install:
+
+```bash
+gem install segregate
+```
+
+## Using Segregate
+
+Require Segregate at the start of your code
+
+```ruby
+require 'segregate'
+```
+
+### Basic useage
+#### Parsing data:
+
+```ruby
+parser = Segregate.new
+parser.parse data
+```
+
+#### Accessing data:
+
+```Ruby
+parser.request_line
+parser.request_method
+parser.request_url
+
+parser.status_line
+parser.status_code
+parser.status_phrase
+
+parser.http_version
+parser.major_http_version
+parser.minor_http_version
+
+parser.headers
+parser.body
+
+parser.raw_data
+```
+
+#### Modifying data:
+
+```Ruby
+parser.request_method = "POST"
+parser.path = "/new/endpoint"
+
+parser.status_code = 404
+parser.status_phrase = "Not Found"
+
+parser.http_version = [0.2]
+parser.major_http_version = 3
+parser.minor_http_version = 4
+
+parser.headers.host = "www.example.com"
+parser.headers['accept'] = "application/json"
+
+parser.body.sub! "data", "information"
+```
+
+### Callback useage
+
+```Ruby
+class Callback_object
+  def on_message_begin parser
+  end
+
+  def on_request_line parser
+  end
+
+  def on_status_line parser
+  end
+
+  def on_headers_complete parser
+  end
+
+  def on_body chunk
+  end
+
+  def on_body_complete parser
+  end
+end
+```
+
+```Ruby
+parser = Segregate.new(Callback_object.new)
+```
+
+### Segregate with event machine
+
+```Ruby
+module MyHttpConnection
+  def connection_completed
+    @parser = Segregate.new(self)
+  end
+
+  def receive_data(data)
+    @parser << data
+  end
+
+  def on_body_complete parser
+    puts parser.body
+  end
+end
+```
+
+## Rebuilding message
+### Forwarding raw data
+
+```Ruby
+socket.write parser.raw_data
+```

data/lib/segregate/version.rb

@@ -1,4 +1,4 @@
 class Segregate
-	VERSION = "0.2.0".freeze
+	VERSION = "0.3.0".freeze
   DATE = "2014-02-03".freeze
 end

data/lib/segregate.rb

@@ -4,7 +4,8 @@ require 'segregate/http_methods'
 require 'segregate/http_regular_expressions'
 
 class Segregate
-  attr_reader :uri, :request_method, :status_code, :status_phrase, :http_version, :headers, :body
+  attr_reader :uri
+  attr_accessor :request_method, :status_code, :status_phrase, :http_version, :headers, :body
 
   def method_missing meth, *args, &block
     if @uri.respond_to? meth
@@ -18,13 +19,8 @@ class Segregate
     @uri.respond_to?(meth, include_private) || super
   end
 
-  def initialize callback = nil
+  def initialize callback = nil 
     @callback = callback
-
-    @uri = nil
-    @request_method = nil
-    @status_code = nil
-    @status_phrase = nil
     @http_version = [nil, nil]
 
     @headers = Hashie::Mash.new
@@ -36,7 +32,7 @@ class Segregate
     @first_line_complete = false
     @headers_complete = false
     @body_complete = false
-    @header_order = []
+    @header_orders = []
   end
 
   def request?
@@ -71,10 +67,42 @@ class Segregate
     http_version[0]
   end
 
+  def major_http_version= val
+    http_version[0] = val
+  end
+
   def minor_http_version
     http_version[1]
   end
 
+  def minor_http_version= val
+    http_version[1] = val
+  end
+
+  def update_content_length
+    if @body_complete
+      @headers['content-length'] = @body.length.to_s
+      @header_orders.push 'content-length' unless @header_orders.include? 'content-length'
+      @headers.delete 'content-encoding'
+      @header_orders.delete 'content-encoding'
+    else
+      raise "ERROR: parsing message body not complete"
+    end
+  end
+
+  def raw_data
+    raw_message = ""
+    update_content_length
+
+    request? ? raw_message << request_line + "\r\n" : raw_message << status_line + "\r\n"
+
+    @header_orders.each do |header|
+      raw_message << "%s: %s\r\n" % [header, headers[header]]
+    end
+
+    raw_message << "\r\n" + @body + "\r\n\r\n"
+  end
+
   def parse data
     raise "ERROR: parsing completed" if @body_complete
 
@@ -138,7 +166,7 @@ class Segregate
       else
         key, value = line.split(":")
         @headers[key.downcase] = value.strip
-        @header_order << key.downcase
+        @header_orders << key.downcase
       end
     end
 
@@ -157,6 +185,7 @@ class Segregate
 
   def parse_body data
     @body = read data, headers['content-length'].to_i
+    @callback.on_body @body if @callback.respond_to?(:on_body)
     @body_complete = true
   end
 
@@ -166,7 +195,9 @@ class Segregate
       if chunk_size == 0
         @body_complete = true
       else
-        @body << read(data, chunk_size)
+        chunk = read(data, chunk_size)
+        @body << chunk
+        @callback.on_body chunk if @callback.respond_to?(:on_body)
       end
     end
   end

data/spec/segregate_spec.rb

@@ -61,6 +61,24 @@ describe Segregate do
         it 'returns a request line' do
           expect(@parser.request_line).to match Segregate::REQUEST_LINE
         end
+
+        it 'returns a modified method request line' do
+          @parser.request_method = 'POST'
+          expect(@parser.request_line).to match Segregate::REQUEST_LINE
+          expect(@parser.request_line).to eq "POST /endpoint HTTP/1.1"
+        end
+
+        it 'returns a modified path request line' do
+          @parser.path = "/new/endpoint"
+          expect(@parser.request_line).to match Segregate::REQUEST_LINE
+          expect(@parser.request_line).to eq "GET /new/endpoint HTTP/1.1"
+        end
+
+        it 'returns a modified http version request line' do
+          @parser.http_version = [2,3]
+          expect(@parser.request_line).to match Segregate::REQUEST_LINE
+          expect(@parser.request_line).to eq "GET /endpoint HTTP/2.3"
+        end
       end
 
       describe '#status_line' do
@@ -186,6 +204,24 @@ describe Segregate do
         it 'returns a status line' do
           expect(@parser.status_line).to match Segregate::STATUS_LINE
         end
+
+        it 'returns a modified http version status line' do
+          @parser.http_version = [2,3]
+          expect(@parser.status_line).to match Segregate::STATUS_LINE
+          expect(@parser.status_line).to eq "HTTP/2.3 200 OK"
+        end
+
+        it 'returns a modified status code status line' do
+          @parser.status_code = 404
+          expect(@parser.status_line).to match Segregate::STATUS_LINE
+          expect(@parser.status_line).to eq "HTTP/1.1 404 OK"
+        end
+
+        it 'returns a modified status phrase status line' do
+          @parser.status_phrase = 'NOT_OK'
+          expect(@parser.status_line).to match Segregate::STATUS_LINE
+          expect(@parser.status_line).to eq "HTTP/1.1 200 NOT_OK"
+        end
       end
 
       describe '#request?' do
@@ -312,6 +348,12 @@ describe Segregate do
           expect(@parser.headers.accept).to eq 'application/json'
           expect(@parser.headers.host).to eq 'www.google.com'
         end
+
+        it 'contains modified headers' do
+          @parser.headers.host = 'www.yahoo.com'
+          expect(@parser.headers).to respond_to(:host)
+          expect(@parser.headers.host).to eq 'www.yahoo.com'
+        end
       end
 
       describe '#headers_complete?' do
@@ -336,7 +378,7 @@ describe Segregate do
         end
 
         it 'contains the body text' do
-          expect(@parser.body).to eq "This is the content!"
+          expect(@parser.body).to eq 'This is the content!'
         end
       end
 
@@ -345,6 +387,21 @@ describe Segregate do
           expect(@parser.body_complete?).to be_an_instance_of TrueClass
         end
       end
+
+      describe '#update_content_length' do
+        it 'updates the content lenght header' do
+          expect(@parser.headers['content-length']).to eq '20'
+          @parser.body = 'new content'
+          @parser.update_content_length
+          expect(@parser.headers['content-length']).to eq '11'
+        end
+      end
+
+      describe '#raw_data' do
+        it 'returns the raw message' do
+          expect(@parser.raw_data).to eq "GET /endpoint HTTP/1.1\r\nhost: www.google.com\r\ncontent-length: 20\r\n\r\nThis is the content!\r\n\r\n"
+        end
+      end
     end
 
     context 'a partial chunked body has been parsed' do
@@ -362,7 +419,7 @@ describe Segregate do
         end
 
         it 'contains the body text' do
-          expect(@parser.body).to eq "This is the first content!"
+          expect(@parser.body).to eq 'This is the first content!'
         end
       end
 
@@ -372,6 +429,18 @@ describe Segregate do
         end
       end
 
+      describe '#update_content_length' do
+        it 'raises an error if the body is not complete' do
+          expect{ @parser.update_content_length }.to raise_error RuntimeError, 'ERROR: parsing message body not complete'
+        end
+      end
+
+      describe '#raw_data' do
+        it 'raises an error if the body is not complete' do
+          expect{ @parser.raw_data }.to raise_error RuntimeError, 'ERROR: parsing message body not complete'
+        end
+      end
+
       context 'the body parsing is completed' do
         before(:each) do
           @parser.parse "27\r\nThis is the second content!\r\n"
@@ -384,7 +453,12 @@ describe Segregate do
           end
 
           it 'contains the body text' do
-            expect(@parser.body).to eq "This is the first content!This is the second content!"
+            expect(@parser.body).to eq 'This is the first content!This is the second content!'
+          end
+
+          it 'contains the modified body' do
+            @parser.body.sub!('first', 'third')
+            expect(@parser.body).to eq 'This is the third content!This is the second content!'
           end
         end
 
@@ -393,6 +467,23 @@ describe Segregate do
             expect(@parser.body_complete?).to be_an_instance_of TrueClass
           end
         end
+
+        describe '#update_content_length' do
+          it 'updates the content lenght header' do
+            expect(@parser.headers['content-length']).to be_nil
+            expect(@parser.headers['content-encoding']).to eq 'chunked'
+            @parser.body = 'new content'
+            @parser.update_content_length
+            expect(@parser.headers['content-length']).to eq '11'
+            expect(@parser.headers['content-encoding']).to be_nil
+          end
+        end
+
+        describe '#raw_data' do
+          it 'returns the raw message' do
+            expect(@parser.raw_data).to eq "GET /endpoint HTTP/1.1\r\nhost: www.google.com\r\ncontent-length: 53\r\n\r\nThis is the first content!This is the second content!\r\n\r\n"
+          end
+        end
       end
     end
   end
@@ -432,6 +523,15 @@ describe Segregate do
       end
     end
 
+    describe 'on_body' do
+      it 'calls the callback object' do
+        @callback_object.should_receive(:on_body).with("TestData")
+        @parser.parse "GET /endpoint HTTP/1.1\r\n"
+        @parser.parse "Content-Length: 8\r\n\r\n"
+        @parser.parse "TestData\r\n\r\n"
+      end
+    end
+
     describe 'on_body_complete' do
       it 'calls the callback object' do
         @callback_object.should_receive(:on_body_complete).with(@parser)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: segregate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Slaughter