songkick-transport 0.1.0 → 0.1.1

data/README.rdoc

@@ -253,6 +253,11 @@ This method accepts both strings and regexes. Any parameter name (as serialized
 in a query string) that matches one of these will be logged as e.g.
 <tt>password=[REMOVED]</tt>.
 
+It also sanitizes custom headers that are put in the logs, so you might want to
+exclude headers used for authentication:
+
+    Songkick::Transport.sanitize /Authorization/i, /Cookie/i
+
 There is also a more advanced reporting system that lets you aggregate request
 statistics. During a request to a web application, many requests to backend
 services may be involved. The repoting system lets you collect information about

data/lib/songkick/transport/base.rb

@@ -7,7 +7,7 @@ module Songkick
       HTTP_VERBS.each do |verb|
         class_eval %{
           def #{verb}(path, params = {}, head = {}, timeout = nil)
-            req = Request.new(endpoint, '#{verb}', path, params, headers.merge(head), timeout)
+            req = Request.new(endpoint, '#{verb}', path, params, headers.merge(head), timeout, Time.now)
             Reporting.log_request(req)
             
             response = execute_request(req)

data/lib/songkick/transport/request.rb

@@ -63,6 +63,10 @@ module Songkick
       def to_s
         url = Serialization.build_url(@verb, @endpoint, @path, @params, true)
         command = "#{@verb.upcase} '#{url}'"
+        @headers.each do |key, value|
+          value = Serialization::SANITIZED_VALUE if Serialization.sanitize?(key)
+          command << " -H '#{key}: #{value}'"
+        end
         return command unless use_body?
         query = Serialization.build_query_string(params, true, true)
         command << " -H 'Content-Type: #{content_type}'"

data/lib/songkick/transport/serialization.rb

@@ -16,9 +16,7 @@ module Songkick
       def build_query_string(params, fully_encode = true, sanitize = false)
         pairs = []
         each_qs_param('', params) do |key, value|
-          if sanitize and sanitize?(key)
-            value = SANITIZED_VALUE
-          end
+          value = SANITIZED_VALUE if sanitize and sanitize?(key)
           pairs << [key, value]
         end
         if fully_encode

data/spec/songkick/transport/request_spec.rb

@@ -5,8 +5,12 @@ describe Songkick::Transport::Request do
     {:username => "Louis", :password => "CK", :access => {:token => "foo"}}
   end
   
+  let :headers do
+    {"Authorization" => "Hello"}
+  end
+  
   let :get_request do
-    Songkick::Transport::Request.new("www.example.com", "GET", "/", params)
+    Songkick::Transport::Request.new("www.example.com", "GET", "/", params, headers)
   end
   
   let :post_request do
@@ -20,7 +24,7 @@ describe Songkick::Transport::Request do
   describe :to_s do
     context "with a get request" do
       it "returns the request as a curl command" do
-        pattern = %r{^GET 'www.example.com/\?([^']+)'$}
+        pattern = %r{^GET 'www.example.com/\?([^']+)' -H 'Authorization: Hello'$}
         get_request.to_s.should =~ pattern
         query(get_request, pattern).should == ["access[token]=foo", "password=CK", "username=Louis"]
       end
@@ -36,12 +40,12 @@ describe Songkick::Transport::Request do
     
     describe "with query sanitization" do
       before do
-        Songkick::Transport.stub(:sanitized_params).and_return [/password/, "access[token]"]
+        Songkick::Transport.stub(:sanitized_params).and_return [/password/, "access[token]", /Authorization/i]
       end
 
       context "with a get request" do
         it "removes the parameter values from the request" do
-          pattern = %r{^GET 'www.example.com/\?([^']+)'$}
+          pattern = %r{^GET 'www.example.com/\?([^']+)' -H 'Authorization: \[REMOVED\]'$}
           get_request.to_s.should =~ pattern
           query(get_request, pattern).should == ["access[token]=[REMOVED]", "password=[REMOVED]", "username=Louis"]
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: songkick-transport
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-25 00:00:00.000000000 Z
+date: 2012-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post