lookout-rack-utils 3.0.1.11 → 3.1.0.12

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjU0ZmVkMThlN2IxNThhZjY4YzNjMTc2NmI2ZWJlM2ZjODMzNWQxYg==
+    ZmMzMzI1NjY3NDYxZmZhYjc4ZGZhMzVmODFjNTQ0NjlmNWIzMTQ5ZA==
   data.tar.gz: !binary |-
-    Y2JkNmUzZjY5Y2Q5MTRhMmYyOWM2ZjdjNTRiOGM0ZGI1MDk3ZmY1Yw==
+    YzJiOTE1MTJhMDU0N2I5Y2M2ODUzN2MxNzYzYzQ0NjI0MTg5YjU5Ng==
 SHA512:
   metadata.gz: !binary |-
-    NTcwODkzN2ZkOGI4YTg0NDIxZTM3MjQzOGNkNjI0OGEyMjc4ODJmMjFiNWFi
-    NGQzY2FkN2M0OWJmNDNmZGQ3MDgwYjJhMTlhY2M5YmY5MzAzOTlhYTY2YTYz
-    NTg1ZDQwMzFjOTMyNzQ3N2VhNTIyNzg0MTBmYWJiMDBlMjAyMDY=
+    ZTJmYzY3NWM0NzBjMzk5MjdmYTkxYmMyZGEyYjAwOWNhYjM4OTAxYTgwMTM1
+    M2FjZTIwM2NmMTNhZjg4Mjk3YzI2NWMxYTM5YjljNmY0ZTMzNDFmZmVhZjU3
+    NmNkZWNjODk3Y2QyOTI5YmM4YjYwMzY3ZGMzYjFiMmNhMGM0YTM=
   data.tar.gz: !binary |-
-    MDdkOTczM2VmNjBiNWU2MGM4ZTNhYWRhMzgyMmY5N2RmYzFiZjk0MGIzODRm
-    N2QzNTBmMzA3MmVlMTljMDAzNzYyMDdmYmFkN2NhY2JjNzNjNjlkYjJhZWQx
-    MjU5MGZkNzQ3MjhhYWIyYmQ0Mjg2OTRiZWU3YWIxYWVkM2Q1OTM=
+    MDkzODg2YTkyMzM1MTNiZDIyYjg3OWVlMzNkMjQ2NWIzMjc0OWVlMTgxNWMy
+    MjZiNDExNjQwZTAzNWZhMTNmNjE4NGM3ZDJlY2VjY2YxNjFjOGE0NGEzMWY5
+    YzJmMmJmNWQ2OGExYTJlNGZiMTliNDU3NzU5YWU4MWVmMGIwMjQ=

data/lib/lookout/rack/utils/request.rb

@@ -1,6 +1,10 @@
+require 'zlib'
+
 module Lookout::Rack::Utils
   module Request
     ILLEGAL_CHARS_REGEX = /[<>]/
+    HTTP_CONTENT_ENCODING_KEY = "HTTP_CONTENT_ENCODING".freeze
+    CONTENT_ENCODING_GZIPPED = "gzip".freeze
 
     # Return the raw, unprocessed request body
     #
@@ -11,11 +15,32 @@ module Lookout::Rack::Utils
       return request.body.read
     end
 
-    # Process and parse the request body as JSON
+    # Return the body, which is gunzipped only if the appropriate header is set on the request
     #
     # Will halt and create a a 400 status code if there is something wrong with
     # the body
     #
+    # @return  [String]
+    def gunzipped_body
+      body = raw_body
+      if request.env[HTTP_CONTENT_ENCODING_KEY] != CONTENT_ENCODING_GZIPPED
+        return body
+      else
+        begin
+          return gunzip(body)
+        rescue Zlib::Error
+          if defined?(Lookout::Rack::Utils::Log)
+            Lookout::Rack::Utils::Log.instance.warn "Unzipping error when decompressing request body (#{body})"
+          end
+          halt 400, "{}"
+        end
+      end
+    end
+
+    # Process and parse the request body as JSON
+    #
+    # Will halt and create a a 400 status code if there is something wrong with
+    # the body
     def body_as_json
       body = raw_body
 
@@ -31,5 +56,24 @@ module Lookout::Rack::Utils
         halt 400, "{}"
       end
     end
+
+    private
+
+    # Decompresses data
+    #
+    # @raise [Zlib::Error] if malformed data is provided
+    # @return [String]
+    def gunzip(data)
+      # We set the window bits to MAX_WBITS + 32 to enable zlib and gzip decoding
+      # with automatic header detection.
+      zstream = Zlib::Inflate.new(Zlib::MAX_WBITS+32)
+      begin
+        decompressed = zstream.inflate(data)
+      ensure
+        zstream.close
+      end
+      decompressed
+    end
+
   end
 end

data/lib/lookout/rack/utils/version.rb

@@ -1,7 +1,7 @@
 module Lookout
   module Rack
     module Utils
-      VERSION = "3.0.1"
+      VERSION = "3.1.0"
     end
   end
 end

data/spec/request_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'lookout/rack/utils/request'
+require 'zlib'
+
+class TestHelper
+  attr_accessor :request
+
+  include Lookout::Rack::Utils::Request
+
+  def initialize
+  end
+end
+
+
+describe Lookout::Rack::Utils::Request do
+  let(:helper) { TestHelper.new }
+  let(:sample_data) {'i am groot'}
+  let(:zipped_sample_data){Zlib::Deflate.deflate(sample_data)}
+
+  describe '#gunzipped_body' do
+
+    before :each do
+      helper.request = Object.new
+      helper.request.stub(:env).and_return({'HTTP_CONTENT_ENCODING' => 'gzip'})
+      helper.request.stub(:body).and_return(double)
+      helper.request.body.stub(:rewind).and_return(double)
+    end
+
+    it 'should unzip data zipped data properly' do
+      helper.request.body.stub(:read).and_return(zipped_sample_data)
+      expect(helper.gunzipped_body).to eq(sample_data)
+    end
+
+    it 'should do nothing if encoding is not set' do
+      helper.request.stub(:env).and_return({})
+      helper.request.body.stub(:read).and_return(zipped_sample_data)
+      expect(helper.gunzipped_body).to eq(zipped_sample_data)
+    end
+
+    it 'should halt and throw and 400 when we have badly encoded data' do
+      allow_any_instance_of(Lookout::Rack::Utils::Log).to receive(:warn)
+      helper.request.body.stub(:read).and_return(sample_data)
+      expect(helper).to receive(:halt).with(400, "{}")
+      helper.gunzipped_body
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookout-rack-utils
 version: !ruby/object:Gem::Version
-  version: 3.0.1.11
+  version: 3.1.0.12
 platform: ruby
 authors:
 - Ian Smith
@@ -216,6 +216,7 @@ files:
 - spec/graphite_spec.rb
 - spec/i18n_spec.rb
 - spec/log_spec.rb
+- spec/request_spec.rb
 - spec/spec_helper.rb
 - spec/subroute_spec.rb
 - spec/support/routehelpers.rb
@@ -248,6 +249,7 @@ test_files:
 - spec/graphite_spec.rb
 - spec/i18n_spec.rb
 - spec/log_spec.rb
+- spec/request_spec.rb
 - spec/spec_helper.rb
 - spec/subroute_spec.rb
 - spec/support/routehelpers.rb