integration_wrapper 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2012-09-28
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+header.txt
+lib/integration_wrapper.rb
+lib/integration_wrapper/base.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_integration_wrapper.rb

data/README.rdoc

@@ -0,0 +1,82 @@
+= integration_wrapper
+
+* http://github.com/cmdjohnson/integration_wrapper
+
+== DESCRIPTION:
+
+Helps you test classes that normally use an Internet connection.
+
+== FEATURES/PROBLEMS:
+
+Every method on a class is suffixed by _online and _offline. 
+When you call a method 'foo', 'foo_online' or 'foo_offline' will be called,
+depending on the mode currently used. 
+
+== SYNOPSIS:
+ # First, create a directory called 'test_online' which will contain your online tests.
+
+ # lib/internet_wrapper.rb
+ class InternetChecker < IntegrationWrapper::Base
+	def check_offline
+		# for offline test, always assume check passes.
+		true
+	end
+
+	def check_online
+		# for online test, do the actual interfacing to the
+		# third party service.
+		handle = open('http://www.google.com/')
+		# etc ...
+	end
+ end
+
+ # test/online/internet_checker_test.rb
+ class InternetCheckerTest < IntegrationWrapper::OnlineTest
+ 	def test_check
+		# this test is automatically executed in ONLINE mode
+		# will invoke 'check_online'
+		InternetChecker.new.check
+	end
+ end
+
+ # test/unit/internet_checker_test.rb
+ class InternetCheckerTest < ActiveRecord::TestCase
+ 	def test_check
+		# this test is executed in OFFLINE mode
+		# will invoke 'check_offline'
+		InternetChecker.new.check
+	end
+ end
+
+== REQUIREMENTS:
+
+ - Rails (Tested with 2.3.14)
+
+== INSTALL:
+
+ - sudo gem install integration_wrapper
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Commander Johnson <commanderjohnson@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/integration_wrapper'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'integration_wrapper' do
+  self.developer 'Commander Johnson', 'commanderjohnson@gmail.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/header.txt

@@ -0,0 +1,6 @@
+###############################################################################
+# Author: Commander Johnson <commanderjohnson@gmail.com>
+# Licensed under the MIT License
+# Year: 2012
+###############################################################################
+

data/lib/integration_wrapper/base.rb

@@ -0,0 +1,48 @@
+# Wrapper that can be used to still properly test online integration with 3rd party tools such as Amazon S3.
+module IntegrationWrapper
+  class Base
+    ################################################################################
+    # 2 modes
+    ################################################################################
+    MODE_ONLINE = "online"
+    MODE_OFFLINE = "offline"
+
+    ################################################################################
+    # class methods
+    ################################################################################
+
+    @@mode = RAILS_ENV.eql?("production") ? MODE_ONLINE : MODE_OFFLINE
+  
+    def initialize(params = {})
+      #@mode = RAILS_ENV.eql?("production") ? MODE_ONLINE : MODE_OFFLINE
+    end
+  
+    def self.mode
+      @@mode
+    end
+
+    def self.mode= thing
+      raise "Mode must be MODE_ONLINE or MODE_OFFLINE" unless thing.eql?(MODE_ONLINE) || thing.eql?(MODE_OFFLINE)
+      @@mode = thing
+    end
+
+    # If an action comes in, say :foo, then call the foo_online class method if mode is online, and foo_offline if mode is offline.
+    #  def self.perform_action action_name, options = {}
+    #    self.send("#{action_name}_#{@@mode}", options)
+    #  end
+
+    def method_missing sym, *args, &block
+      # First check if the method we're trying to call is available.
+      name = "#{sym}_#{@@mode}"
+      # Now send
+      begin
+        self.send name, *args, &block
+      rescue NoMethodError => e      
+        puts "Error trying to call method #{name}. Maybe you forgot to add it? I need all methods to be suffixed with either #{IntegrationWrapper::MODE_ONLINE} or #{IntegrationWrapper::MODE_OFFLINE}. Example: foo_online. Methods: #{methods.inspect}. Error was: #{e}."
+        puts "Trace:"
+        puts e.backtrace
+        raise e
+      end
+    end
+  end
+end

data/lib/integration_wrapper.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module IntegrationWrapper
+  VERSION = '0.0.1'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/integration_wrapper.rb'}"
+puts "Loading integration_wrapper gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/integration_wrapper'

data/test/test_integration_wrapper.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestIntegrationWrapper < Test::Unit::TestCase
+  def setup
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: integration_wrapper
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Commander Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  type: :development
+  version_requirements: *id003
+description: Helps you test classes that normally use an Internet connection.
+email: 
+- commanderjohnson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- header.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- header.txt
+- lib/integration_wrapper.rb
+- lib/integration_wrapper/base.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_integration_wrapper.rb
+- .gemtest
+homepage: http://github.com/cmdjohnson/integration_wrapper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: integration_wrapper
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Helps you test classes that normally use an Internet connection.
+test_files: 
+- test/test_helper.rb
+- test/test_integration_wrapper.rb