tivo 0.0.1.alpha

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Kevin W. Gisi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= Tivo
+
+A VCR-inspired convention-based web-request stubbing mechanism.
+
+== ALPHA ALPHA ALPHA Disclaimer
+
+This gem is alpha. Very alpha. It should not be used in production. It should not be used as an example of "clean code" or "best practices". It is under heavy development, and may change, be refactored, be completely removed, at a moment's notice. The author disavows any responsibility if your code breaks via its use. Be very certain you know what you're doing if you look at this code - it is, to repeat, alpha.
+
+== Installation
+
+In your Gemfile, add:
+  
+  gem "tivo"
+
+== Copyright
+
+Copyright (c) 2012 Kevin W. Gisi. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tivo'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--backtrace']
+end
+
+task :default => :spec

data/lib/tasks/tivo_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tivo do
+#   # Task goes here
+# end

data/lib/tivo.rb

@@ -0,0 +1,24 @@
+module Tivo
+  @enabled = true
+
+  class << self
+    def enabled?
+      @enabled
+    end
+
+    def enable!
+      @enabled = true
+    end
+
+    def disable!
+      @enabled = false
+    end
+  end
+end
+
+require_relative 'tivo/pending_request_error'
+require_relative 'tivo/hooks'
+
+require_relative 'tivo/extensions/test_unit'
+require_relative 'tivo/extensions/net_http'
+require_relative 'tivo/extensions/rspec'

data/lib/tivo/extensions/net_http.rb

@@ -0,0 +1,3 @@
+require 'net/http'
+
+require_relative 'net_http/net/http'

data/lib/tivo/extensions/net_http/net/http.rb

@@ -0,0 +1,20 @@
+require 'net/http'
+
+module Net
+  class HTTP
+    def request_with_tivo(request, body = nil, &block)
+      if Tivo.enabled?
+        net_http = self
+        protocol = net_http.use_ssl? ? 'https' : 'http'
+        path = (request.path =~ /^http/ ? URI.parse(request.path).request_uri : request.path)
+        full_path = "#{protocol}://#{net_http.address}:#{net_http.port}#{path}"
+        raise Tivo::PendingRequestError, "Intercepted a request to #{full_path}"
+      else
+        request_without_tivo(request,body,&block)
+      end
+    end
+
+    alias_method :request_without_tivo, :request
+    alias_method :request, :request_with_tivo
+  end
+end

data/lib/tivo/extensions/rspec.rb

@@ -0,0 +1,4 @@
+if defined?(RSpec)
+  require_relative 'rspec/core/example'
+  require_relative 'rspec/core/example_group'
+end

data/lib/tivo/extensions/rspec/core/example.rb

@@ -0,0 +1,46 @@
+module RSpec
+  module Core
+    class Example
+      
+      def run(example_group_instance, reporter)
+        @example_group_instance = example_group_instance
+        @example_group_instance.example = self
+
+        start(reporter)
+
+        begin
+          unless pending
+            with_around_each_hooks do
+              begin
+                run_before_each
+                @example_group_instance.instance_eval(&@example_block)
+              rescue Tivo::PendingRequestError => e
+                @pending_declared_in_example = e.message
+              rescue Exception => e
+                set_exception(e)
+              ensure
+                run_after_each
+              end
+            end
+          end
+        rescue Exception => e
+          set_exception(e)
+        ensure
+          @example_group_instance.instance_variables.each do |ivar|
+            @example_group_instance.instance_variable_set(ivar, nil)
+          end
+          @example_group_instance = nil
+
+          begin
+            assign_auto_description
+          rescue Exception => e
+            set_exception(e)
+          end
+        end
+
+        finish(reporter)
+      end
+
+    end
+  end
+end

data/lib/tivo/extensions/rspec/core/example_group.rb

@@ -0,0 +1,34 @@
+module RSpec
+  module Core
+    class ExampleGroup
+      include Tivo::Hooks
+
+      def self.run_after_all_hooks(example_group_instance)
+        return if descendant_filtered_examples.empty?
+        assign_before_all_ivars(before_all_ivars, example_group_instance)
+
+        begin
+          run_hook(:after, :all, example_group_instance)
+        rescue Tivo::PendingRequestError => e
+          RSpec.configuration.reporter.message <<-EOS
+
+A Tivo error occurred in an after(:all) hook.
+  #{e.class}: #{e.message}
+  occurred at #{e.backtrace.first}
+
+        EOS
+        rescue => e
+          # TODO: come up with a better solution for this.
+          RSpec.configuration.reporter.message <<-EOS
+
+An error occurred in an after(:all) hook.
+  #{e.class}: #{e.message}
+  occurred at #{e.backtrace.first}
+
+        EOS
+        end
+      end
+
+    end
+  end
+end

data/lib/tivo/extensions/test/unit.rb

@@ -0,0 +1,31 @@
+module Test::Unit
+  class TestCase
+    include Tivo::Hooks
+  end
+
+  class Runner
+    # Overriding of MiniTest::Unit#puke
+    def puke klass, meth, e
+      # TODO:
+      #   this overriding is for minitest feature that skip messages are
+      #   hidden when not verbose (-v), note this is temporally.
+      e = case e
+          when Tivo::PendingRequestError then
+            @skips += 1
+            "Skipped:\n#{meth}(#{klass}) [#{location e}]:\n#{e.message}\n"
+          when MiniTest::Skip then
+            @skips += 1
+            "Skipped:\n#{meth}(#{klass}) [#{location e}]:\n#{e.message}\n"
+          when MiniTest::Assertion then
+            @failures += 1
+            "Failure:\n#{meth}(#{klass}) [#{location e}]:\n#{e.message}\n"
+          else
+            @errors += 1
+            bt = MiniTest::filter_backtrace(e.backtrace).join "\n    "
+            "Error:\n#{meth}(#{klass}):\n#{e.class}: #{e.message}\n    #{bt}\n"
+          end
+      @report << e
+      e[0, 1]
+    end
+  end
+end

data/lib/tivo/extensions/test_unit.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+
+require_relative 'test/unit'

data/lib/tivo/hooks.rb

@@ -0,0 +1,10 @@
+module Tivo::Hooks
+  def without_tivo
+    Tivo.disable!
+    begin
+      yield
+    ensure
+      Tivo.enable!
+    end
+  end
+end

data/lib/tivo/pending_request_error.rb

@@ -0,0 +1,4 @@
+module Tivo
+  class PendingRequestError < StandardError
+  end
+end

data/lib/tivo/version.rb

@@ -0,0 +1,3 @@
+module Tivo
+  VERSION = "0.0.1.alpha"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+Dir["#{File.dirname(__FILE__)}/../lib/*.rb"].each { |f| require f }

data/spec/tivo_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'open-uri'
+
+describe 'Tivo' do
+  it 'should skip tests requiring web requests' do
+    open('http://google.com')
+  end
+
+  it 'should allow tivo-escaped blocks' do
+    without_tivo do
+      open('http://google.com')
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/../lib/*.rb"].each { |f| require f }

data/test/tivo_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'open-uri'
+
+class TivoTest < Test::Unit::TestCase
+
+  def test_skip_test_requiring_web_requests
+    open('http://google.com')
+  end
+
+  def test_allow_tivo_escaped_blocks
+    without_tivo do
+      open('http://google.com')
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: tivo
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Kevin W. Gisi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A convention-based web-request stubbing mechanism.
+email:
+- kevin@kevingisi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tasks/tivo_tasks.rake
+- lib/tivo/extensions/net_http/net/http.rb
+- lib/tivo/extensions/net_http.rb
+- lib/tivo/extensions/rspec/core/example.rb
+- lib/tivo/extensions/rspec/core/example_group.rb
+- lib/tivo/extensions/rspec.rb
+- lib/tivo/extensions/test/unit.rb
+- lib/tivo/extensions/test_unit.rb
+- lib/tivo/hooks.rb
+- lib/tivo/pending_request_error.rb
+- lib/tivo/version.rb
+- lib/tivo.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/test_helper.rb
+- test/tivo_test.rb
+- spec/spec_helper.rb
+- spec/tivo_spec.rb
+homepage: http://github.com/gisikw/tivo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2168009181208321104
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A convention-based web-request stubbing mechanism.
+test_files:
+- test/test_helper.rb
+- test/tivo_test.rb
+- spec/spec_helper.rb
+- spec/tivo_spec.rb