martinbtt-net-http-spy 0.1.1 → 0.1.2

data/Rakefile

@@ -0,0 +1,40 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "net-http-spy"
+    gemspec.summary = "Ever wondered what HTTP requests the Ruby gem you are using to connect to a third party API is making? Use HTTP Spy to see what is going on behind the scenes."
+    gemspec.email = "martin@beyondthetype.com"
+    gemspec.homepage = "http://github.com/martinbtt/net-http-spy"
+    gemspec.description = "Ever wondered what HTTP requests the Ruby gem you are using to connect to a third party API is making? Use HTTP Spy to see what is going on behind the scenes."
+    gemspec.authors = ["Martin Sadler"]
+    gemspec.files.include Dir["examples/*.rb"] + ["readme.markdown"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+task :default => :spec
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = %w(--format specdoc --colour)
+  t.libs = ["spec"]
+end
+
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "readme.markdown"
+  rd.rdoc_files.include("readme.markdown", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/examples/fogbugz.rb

@@ -0,0 +1,14 @@
+# Just showing an example of something other than Twitter.
+require 'rubygems'
+require 'fogbugz-api' # sudo gem install austinmoody-fogbugz-api
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','spy'))
+
+config = {:username    => "yourusername",
+          :password    => "yourpass", 
+          :domain      => "yourdomain.fogbugz.com"
+          }
+
+Net::HTTP.http_logger_options = {:body => true, :trace => false}
+
+@fogbugz = FogBugz.new(config[:domain],true) # create instance
+@fogbugz.logon(config[:username],config[:password]) # logs into FogBugz and sets *token*

data/examples/google.rb

@@ -0,0 +1,8 @@
+# Just showing an example of something other than Twitter. 
+# Garb lets you access the Google Analytics API
+require 'rubygems'
+require 'garb'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','spy'))
+
+Net::HTTP.http_logger_options = {:body => false, :trace => false, :verbose => false}
+Garb::Session.login('yourgoogleusername', 'yourpassword')

data/examples/twitter-calltrace.rb

@@ -0,0 +1,7 @@
+# See where the external API calls take place within the gem you are using with the :trace option 
+require 'rubygems'
+require 'twitter'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','spy'))
+
+Net::HTTP.http_logger_options = {:trace => true}
+Twitter::Search.new('httparty').each { |r| r }

data/examples/twitter-customlog.rb

@@ -0,0 +1,8 @@
+# By default the logger outputs to STDOUT, it's easy to change this to a file if you like
+# Great to capture and then use for testing with tools like FakeWeb when combined with :body => true 
+require 'rubygems'
+require 'twitter'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','spy'))
+
+Net::HTTP.http_logger = Logger.new('twitter.log')
+Twitter::Search.new('httparty').each { |r| r }

data/examples/twitter-simple.rb

@@ -0,0 +1,6 @@
+# Simplist example. All you need to do is include the spy lib for it to start doing the right thing
+require 'rubygems'
+require 'twitter'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','spy'))
+
+Twitter::Search.new('httparty').each { |r| r }

data/examples/twitter-verbose.rb

@@ -0,0 +1,7 @@
+# Net::HTTP has it's own logging/debug functionality. Turn on :verbose to show the full raw HTTP communication
+require 'rubygems'
+require 'twitter'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','spy'))
+
+Net::HTTP.http_logger_options = {:verbose => true}
+Twitter::Search.new('httparty').each { |r| r }

data/examples/twitter-withbody.rb

@@ -0,0 +1,7 @@
+# Display the full response/request body. Usually just the response code is shown.
+require 'rubygems'
+require 'twitter'
+require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','spy'))
+
+Net::HTTP.http_logger_options = {:body => true}
+Twitter::Search.new('httparty').each { |r| r }

data/lib/net-http-spy.rb

@@ -0,0 +1,50 @@
+require 'net/https'
+require 'logger'
+require 'cgi'
+
+# HTTP SPY
+module Net
+  class HTTP
+    alias :old_initialize :initialize
+    alias :old_request :request
+
+    class << self
+      attr_accessor :http_logger
+      attr_accessor :http_logger_options
+    end
+
+    def initialize(*args, &block)
+      self.class.http_logger_options ||= {}
+      defaults =  {:body => false, :trace => false, :verbose => false}
+      self.class.http_logger_options = (self.class.http_logger_options == :default) ? defaults : self.class.http_logger_options
+      @logger_options = defaults.merge(self.class.http_logger_options)
+      
+      self.class.http_logger.info "CONNECT: #{args.inspect}" if !@logger_options[:verbose]
+
+      old_initialize(*args, &block)
+      @debug_output   = self.class.http_logger if @logger_options[:verbose]
+    end
+
+
+    def request(*args, &block)
+      unless started? || @logger_options[:verbose]
+        req = args[0].class::METHOD
+        self.class.http_logger.info "#{req} #{args[0].path}"
+      end
+
+      result = old_request(*args, &block)
+      unless started? || @logger_options[:verbose]
+
+        self.class.http_logger.info "PARAMS #{CGI.parse(args[0].body).inspect} " if args[0].body && req != 'CONNECT'
+        self.class.http_logger.info "TRACE: #{caller.reverse}" if @logger_options[:trace]
+        self.class.http_logger.info "BODY: #{  @logger_options[:body] ? result.body : result.class.name}"
+      end
+      result
+    end
+
+
+  end
+
+end
+
+Net::HTTP.http_logger = Logger.new(STDOUT)

data/net-http-spy.gemspec

@@ -0,0 +1,63 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{net-http-spy}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Sadler"]
+  s.date = %q{2009-06-05}
+  s.description = %q{Ever wondered what HTTP requests the Ruby gem you are using to connect to a third party API is making? Use HTTP Spy to see what is going on behind the scenes.}
+  s.email = %q{martin@beyondthetype.com}
+  s.files = [
+    "Rakefile",
+     "VERSION",
+     "examples/fogbugz.rb",
+     "examples/fogbugz.rb",
+     "examples/google.rb",
+     "examples/google.rb",
+     "examples/twitter-calltrace.rb",
+     "examples/twitter-calltrace.rb",
+     "examples/twitter-customlog.rb",
+     "examples/twitter-customlog.rb",
+     "examples/twitter-simple.rb",
+     "examples/twitter-simple.rb",
+     "examples/twitter-verbose.rb",
+     "examples/twitter-verbose.rb",
+     "examples/twitter-withbody.rb",
+     "examples/twitter-withbody.rb",
+     "lib/net-http-spy.rb",
+     "net-http-spy.gemspec",
+     "readme.markdown",
+     "readme.markdown",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/spy_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/martinbtt/net-http-spy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Ever wondered what HTTP requests the Ruby gem you are using to connect to a third party API is making? Use HTTP Spy to see what is going on behind the scenes.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/spy_spec.rb",
+     "examples/fogbugz.rb",
+     "examples/google.rb",
+     "examples/twitter-calltrace.rb",
+     "examples/twitter-customlog.rb",
+     "examples/twitter-simple.rb",
+     "examples/twitter-verbose.rb",
+     "examples/twitter-withbody.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--format
+  progress
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+require 'net/http'
+require 'open-uri'
+require 'twitter'
+require 'mechanize'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'spy')
+
+
+class DummyLogger 
+  
+  attr_accessor :lines
+  
+  def initialize
+    reset!
+  end
+  
+  def <<(msg)
+    @lines << msg
+  end
+  
+  def info(msg)
+     @lines << msg
+  end
+
+  def reset!
+    @lines = []
+  end
+  
+end

data/spec/spy_spec.rb

@@ -0,0 +1,93 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+# Bare bones spec to make sure the core functionality is working
+describe "Net:HTTP Spying on" do
+  before(:all) do
+    Net::HTTP.http_logger = DummyLogger.new()
+  end
+
+  describe "a get request with default options" do
+  
+    before(:all) do
+      Net::HTTP.http_logger.reset!
+      Twitter::Search.new('httparty').each { |r| r }
+      Net::HTTP.http_logger_options = :default
+  
+    end
+  
+    it "should give the connection" do
+      Net::HTTP.http_logger.lines.should include("CONNECT: [\"search.twitter.com\", 80]")
+    end
+  
+    it "should give GET uri and query string" do
+      Net::HTTP.http_logger.lines.should include("GET /search.json?q=httparty")
+    end
+  
+    it "should give the BODY response code" do
+      Net::HTTP.http_logger.lines.should include("BODY: Net::HTTPOK")
+    end
+  
+  
+  
+  end
+
+
+  describe "a get request with body option set to true" do
+
+    before(:each) do
+      Net::HTTP.http_logger.reset!
+      Net::HTTP.http_logger_options = {:body => true}
+    end
+
+
+    it "should give the body output" do
+       Twitter::Search.new('httparty').each { |r| r }
+       Net::HTTP.http_logger.lines.grep(/BODY: \{\"results\":/).should_not be_empty
+    end
+
+  end
+    
+
+  describe "a get request with trace option set to true" do
+
+    before(:each) do
+      Net::HTTP.http_logger.reset!
+      Net::HTTP.http_logger_options = {:trace => true}
+    end
+
+
+    it "should give the trace output" do
+       Twitter::Search.new('httparty').each { |r| r }
+       Net::HTTP.http_logger.lines.grep(/TRACE: /).should_not be_empty
+    end
+
+  end
+      
+  describe "a post request with default options" do
+  
+    before(:all) do
+      Net::HTTP.http_logger.reset!
+      @connection = Net::HTTP.new('http://search.twitter.com')
+      @connection.post('/','?q=hello')
+    end
+  
+  
+    it "should give the post uri" do
+      Net::HTTP.http_logger.lines.should include("POST /")
+    end
+  
+    it "should give the post params" do
+      Net::HTTP.http_logger.lines.should include("PARAMS {\"?q\"=>[\"hello\"]} ")
+    end
+  
+    it "should give the BODY response code" do
+      Net::HTTP.http_logger.lines.should include("BODY: Net::HTTPFound")
+    end
+  
+  
+  end
+
+
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: martinbtt-net-http-spy
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Martin Sadler
@@ -9,45 +9,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-07 00:00:00 -07:00
+date: 2009-06-05 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: twitter
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: 
+dependencies: []
+
+description: Ever wondered what HTTP requests the Ruby gem you are using to connect to a third party API is making? Use HTTP Spy to see what is going on behind the scenes.
 email: martin@beyondthetype.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- readme.markdown
+extra_rdoc_files: []
+
 files: 
+- Rakefile
+- VERSION
+- examples/fogbugz.rb
+- examples/google.rb
+- examples/twitter-calltrace.rb
+- examples/twitter-customlog.rb
+- examples/twitter-simple.rb
+- examples/twitter-verbose.rb
+- examples/twitter-withbody.rb
+- lib/net-http-spy.rb
+- net-http-spy.gemspec
 - readme.markdown
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/spy_spec.rb
 has_rdoc: false
 homepage: http://github.com/martinbtt/net-http-spy
 post_install_message: 
 rdoc_options: 
-- --main
-- readme.markdown
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -69,5 +63,13 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Ever wondered what HTTP requests the Ruby gem you are using to connect to a third party API is making? Use HTTP Spy to see what is going on behind the scenes.
-test_files: []
-
+test_files: 
+- spec/spec_helper.rb
+- spec/spy_spec.rb
+- examples/fogbugz.rb
+- examples/google.rb
+- examples/twitter-calltrace.rb
+- examples/twitter-customlog.rb
+- examples/twitter-simple.rb
+- examples/twitter-verbose.rb
+- examples/twitter-withbody.rb