blindfold 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+pkg
+rdoc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 James Bunch
+
+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,29 @@
+= Blindfold
+
+API/XML focused integration testing for Rack apps
+
+== What is Blindfold?
+
+Blindfold brings together RSpec, Rack::Test, and Machinist for the
+express purpose of providing integration test coverage for web based
+API services (especially those with an XML response).
+
+== Usage
+
+  $ gem install blindfold
+
+  $ blindfold /path/to/blindfold_test.rb
+
+== Configuration
+
+  (Coming)
+
+== Resources
+
+- Source: http://github.com/fallwith/blindfold
+
+== Credits
+
+Blindfold was created by James Bunch (fallwith) and improved by the SCEA SDOD team
+
+Copyright (c) 2010 James Bunch, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs to test blindfold.'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc 'Generate documentation for blindfold.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Blindfold'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/blindfold

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'isolate/now'
+require 'blindfold'
+
+opts = {:config_dir => File.expand_path(File.dirname(__FILE__) + '/../tests/config'),
+        :rails_root => File.expand_path(File.dirname(__FILE__) + '/..'),
+        :boot_redis => true}
+
+Launcher.new(opts).run(ARGV)

data/blindfold.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name    = 'blindfold'
+  gem.version = '0.0.2'
+  gem.date    = %{2010-06-24}
+
+  gem.authors  = ["James Bunch (fallwith)"]
+  gem.email    = nil
+  gem.homepage = 'http://github.com/fallwith/blindfold'
+
+  gem.summary     = "API/XML focused integration testing for Rack apps"
+  gem.description = "Blindfold brings together RSpec, Rack::Test, and Machinist for the
+                     express purpose of providing integration test coverage for web based
+                     API services (especially those with an XML response)."
+
+  gem.files = [
+    '.gitignore',
+    'bin/blindfold',
+    'blindfold.gemspec',
+    'config/spec.opts',
+    'init.rb',
+    'lib/blindfold/connection.rb',
+    'lib/blindfold/helpers/date.rb',
+    'lib/blindfold/helpers/db.rb',
+    'lib/blindfold/helpers.rb',
+    'lib/blindfold/launcher.rb',
+    'lib/blindfold/spec/matchers/be_an_ip_address.rb',
+    'lib/blindfold/spec/matchers/be_an_iso_date.rb',
+    'lib/blindfold/spec/matchers/be_ok.rb',
+    'lib/blindfold/spec/monkey.rb',
+    'lib/blindfold/spec.rb',
+    'lib/blindfold/xml/monkey.rb',
+    'lib/blindfold/xml.rb',
+    'lib/blindfold.rb',
+    'MIT-LICENSE',
+    'Rakefile',
+    'README.rdoc',
+    'VERSION'
+  ]
+
+  gem.add_dependency('rspec', '>= 1.3.0')
+  gem.add_dependency('rack-test', '>= 0.5.4')
+  gem.add_dependency('machinist', '>= 1.0.6')
+  gem.add_dependency('forgery', '>= 0.3.4')
+end

data/config/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/init.rb

@@ -0,0 +1 @@
+# Placeholder for Rails' benefit

data/lib/blindfold/connection.rb

@@ -0,0 +1,60 @@
+class Connection
+  include Rack::Test::Methods
+
+  def initialize(args={})
+    perform_pre_flight_check
+    log_in unless args.has_key?(:logged_in) && !args[:logged_in]
+  end
+  
+  def log_in
+    # Define for your app's process of logging in
+  end
+  
+  def call(name, params={})
+    method, url = resolve(name)
+    process_request method, url, params
+    @cookie_session_id = last_response.headers['Set-Cookie']
+  end
+  
+  def response
+    last_response
+  end
+  
+  def xml
+    Nokogiri::XML(last_response.body)
+  end
+  
+  private
+
+  def perform_pre_flight_check
+    # Define for your app's prerequisite checks (connection to db, etc.)
+  end
+  
+  def app
+    ActionController::Dispatcher.new # For Rails
+  end
+  
+  def process_request(method, url, params)
+    env_vars = {}  # Define your app's required environment vars
+
+    header('Cookie', @cookie_session_id) if @cookie_session_id
+
+    case method.downcase.to_s
+    when 'get'
+      get url, params, env_vars
+    when 'post'
+      post url, params, env_vars
+    when 'put'
+      put url, params, env_vars
+    when 'delete'
+      delete url, params, env_vars
+    else
+      raise "Unsupported method '#{method}'!"
+    end
+  end
+  
+  def resolve(service)
+    # Define for your app. Return a URL and method for the given service nickname
+    ['get', service]
+  end
+end

data/lib/blindfold/helpers/date.rb

@@ -0,0 +1,7 @@
+module HelperMethods
+  # Inspired by random_data's date method, http://github.com/tomharris/random_data
+  def random_datetime(args={:dayrange => 7, :force_future => false})
+    offset = args[:force_future] ? rand(args[:dayrange]) : (rand(args[:dayrange]*2)-args[:dayrange])
+    Time.now + (offset * 24 * 60 * 60)
+  end
+end

data/lib/blindfold/helpers/db.rb

@@ -0,0 +1,11 @@
+module HelperMethods
+  def wipe(name)
+    klass = name.to_s.singularize.camelize.constantize
+    klass.delete_all
+  end
+
+  def spawn(name, args={})
+    klass = name.to_s.singularize.camelize.constantize
+    klass.make(args)
+  end
+end

data/lib/blindfold/helpers.rb

@@ -0,0 +1 @@
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'helpers','**','*.rb'))].each {|f| require f}

data/lib/blindfold/launcher.rb

@@ -0,0 +1,97 @@
+class Launcher
+  SPEC_OPTS_FILE  = 'spec.opts'
+  BLUEPRINTS_DIR  = 'blueprints'  # lives within config_dir
+  MATCHERS_DIR    = 'matchers'    # lives within config_dir
+  HELPERS_DIR     = 'helpers'     # lives within config_dir
+
+  def initialize(args={})
+    Blindfold.config_dir = args[:config_dir] if args.has_key?(:config_dir)
+    Blindfold.rails_root = args[:rails_root] if args.has_key?(:rails_root)
+    Blindfold.boot_redis = args[:boot_redis] if args.has_key?(:boot_redis)
+  end
+  
+  def run(arguments)
+    start_redis if Blindfold.boot_redis
+    init_rails if Blindfold.rails_root
+    init_helpers
+    init_blueprints
+    init_matchers
+    run_spec(arguments)
+    stop_redis if Blindfold.boot_redis
+  end
+  
+  private
+
+  def init_helpers
+    helpers_dir = File.join(Blindfold.config_dir, HELPERS_DIR)
+    if Dir.exists?(helpers_dir)
+      Dir[File.join(helpers_dir,'**','*.rb')].each {|f| load f}
+    end
+  end
+
+  def init_blueprints
+    # Introduce all helper methods to Machinist
+    Machinist::Lathe.send :include, HelperMethods
+    # Load up all blueprints
+    blueprints_dir = File.join(Blindfold.config_dir, BLUEPRINTS_DIR)
+    if Dir.exists?(blueprints_dir)
+      Dir[File.join(blueprints_dir,'**','*_blueprint.rb')].each {|f| load f}
+    end
+  end
+  
+  def init_matchers
+    matchers_dir = File.join(Blindfold.config_dir, MATCHERS_DIR)
+    if Dir.exists?(matchers_dir)
+      Dir[File.join(matchers_dir,'**','*.rb')].each {|f| load f}
+    end
+  end
+
+  # Light up Spec::Runner
+  def run_spec(args)
+    # Introduce Rack::Test to RSpec
+    Spec::Runner.configure do |config|
+      config.include Rack::Test::Methods
+    end
+
+    # Introduce all helper methods to RSpec
+    Spec::Runner.configuration.include(HelperMethods)
+
+    # Specify which spec.opts file to use
+    spec_opts = File.join(Blindfold.config_dir, SPEC_OPTS_FILE)
+    if File.exists?(spec_opts)
+      args << '-O' << spec_opts
+    end
+
+    ::Spec::Runner::CommandLine.run(::Spec::Runner::OptionParser.parse(args, STDERR, STDOUT))
+  end
+  
+  def init_rails
+    require File.join(Blindfold.rails_root, 'config', 'environment') if Blindfold.rails_root
+  end
+  
+  def redis_pid
+    `ps acx|grep redis-server|awk {'print $1'}`.chomp
+  end
+
+  # Start redis if necessary and requested
+  def start_redis
+    return if RUBY_PLATFORM =~ /mswin|mingw/
+    if redis_pid == ''
+      redis_binary = `which redis-server`.chomp
+      if redis_binary.chomp != ''
+        spawn "echo 'daemonize yes'|#{redis_binary} -"
+        puts "Started redis-server [#{redis_pid}]"
+        @started_redis = true
+      end
+    end
+  end
+
+  # Stop redis if this class started it earlier
+  def stop_redis
+    return unless @started_redis
+    return if RUBY_PLATFORM =~ /mswin|mingw/
+    print 'Stopping redis-server...'
+    `killall redis-server`
+    puts 'Done'
+  end
+end

data/lib/blindfold/spec/matchers/be_an_ip_address.rb

@@ -0,0 +1,14 @@
+Spec::Matchers.define :be_an_ip_address do
+  match do |ip_address|
+    ip_address.to_s =~ /^(?:(?:\d+\.){3}|(?:\d+\.){5})\d+$/
+  end
+  failure_message_for_should do |ip_address|
+    "expected '#{ip_address}' to be a valid IP Address format (v4 or v6)"
+  end
+  failure_message_for_should_not do |ip_address|
+    "expected '#{ip_address}' to not be a valid IP Address format (v4 or v6)"
+  end
+  description do
+    "expected an IP Address to be in a valid format (v4 or v6)"
+  end
+end

data/lib/blindfold/spec/matchers/be_an_iso_date.rb

@@ -0,0 +1,15 @@
+Spec::Matchers.define :be_an_iso_date do
+  pattern = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[-+]\d{2}:\d{2}$/
+  match do |date|
+    date.to_s =~ pattern
+  end
+  failure_message_for_should do |date|
+    "expected '#{date}' to be an ISO 8601 formatted date string (#{pattern})"
+  end
+  failure_message_for_should_not do |date|
+    "expected '#{date}' to not be in ISO 8601 format (#{pattern})"
+  end
+  description do
+    "expected a date string to be in ISO 8601 format"
+  end
+end

data/lib/blindfold/spec/matchers/be_ok.rb

@@ -0,0 +1,47 @@
+module Spec
+  module Matchers
+    # This drills down into the .status and .result objects of
+    # response to see whether they both have successful states.
+    # This is needed because a param validation error may throw
+    # 200 Ok but -5 Invalid param (by design)
+    def be_ok
+      Matcher.new :be_ok do
+        match do |response|
+          status_element = Nokogiri::XML(response.body).xpath('/result/status').first
+          status_id = status_element ? status_element.xpath('id').first.text : nil
+          response.status == 200 && status_id == '0'
+        end
+
+        failure_message_for_should do |response|
+          status_element = Nokogiri::XML(response.body).xpath('/result/status').first
+          if status_element
+            status_id = status_element.xpath('id').first.text
+            status_message = status_element.xpath('message').first.text
+            text = "#{status_id}: #{status_message}"
+          else
+            text = response.body
+          end
+          <<-MESSAGE
+expected HTTP 200 / 0: Successful Completion
+     got HTTP #{response.status} / #{text}
+MESSAGE
+        end
+
+        failure_message_for_should_not do |response|
+          status_element = Nokogiri::XML(response.body).xpath('/result/status').first
+          if status_element
+            status_id = status_element.xpath('id').first.text
+            status_message = status_element.xpath('message').first.text
+            text = "#{status_id}: #{status_message}"
+          else
+            text = response.body
+          end
+          <<-MESSAGE
+expected not HTTP 200 / 0: Successful Completion
+     got HTTP #{response.status} / #{text}
+MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/blindfold/spec/monkey.rb

@@ -0,0 +1,14 @@
+module Spec::Example::ExampleGroupMethods
+  alias scenario example   # Steak
+  alias background before  # Steak
+  def prepare(&block)
+    before :all, &block
+  end
+  def cleanup(&block)
+    after :all, &block
+  end
+end
+
+module Spec::DSL::Main
+  alias feature describe   # Steak
+end

data/lib/blindfold/spec.rb

@@ -0,0 +1 @@
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'spec','**','*.rb'))].each {|f| require f}

data/lib/blindfold/xml/monkey.rb

@@ -0,0 +1,14 @@
+module Nokogiri::XML
+  class Document
+    def elements(name)
+      xpath("//#{name}")
+    end
+  end
+  class NodeSet
+    def with_attributes(attributes)
+      # TODO: refactor to remove eval
+      conditions = attributes.collect{|k,v| "e['#{k.to_s}'] == '#{v.to_s}'"}.join(' && ')
+      eval "select{|e| #{conditions}}"
+    end
+  end
+end

data/lib/blindfold/xml.rb

@@ -0,0 +1 @@
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'xml','**','*.rb'))].each {|f| require f}

data/lib/blindfold.rb

@@ -0,0 +1,22 @@
+class Blindfold
+  require 'spec'
+  require 'machinist/active_record'
+  require 'sham'
+  require 'forgery'
+  require 'rack/test'
+  require 'nokogiri'
+  
+  require 'blindfold/launcher'
+  require 'blindfold/connection'
+  require 'blindfold/spec'
+  require 'blindfold/xml'
+  require 'blindfold/helpers'
+  
+  mattr_accessor :config_dir
+  mattr_accessor :rails_root
+  mattr_accessor :boot_redis
+  
+  @@config_dir = File.dirname(__FILE__) + '/../config'
+  @@rails_root = nil
+  @@boot_redis = false
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: blindfold
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- James Bunch (fallwith)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 5
+        - 4
+        version: 0.5.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: machinist
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 0
+        - 6
+        version: 1.0.6
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: forgery
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 3
+        - 4
+        version: 0.3.4
+  type: :runtime
+  version_requirements: *id004
+description: |-
+  Blindfold brings together RSpec, Rack::Test, and Machinist for the
+                       express purpose of providing integration test coverage for web based
+                       API services (especially those with an XML response).
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- bin/blindfold
+- blindfold.gemspec
+- config/spec.opts
+- init.rb
+- lib/blindfold/connection.rb
+- lib/blindfold/helpers/date.rb
+- lib/blindfold/helpers/db.rb
+- lib/blindfold/helpers.rb
+- lib/blindfold/launcher.rb
+- lib/blindfold/spec/matchers/be_an_ip_address.rb
+- lib/blindfold/spec/matchers/be_an_iso_date.rb
+- lib/blindfold/spec/matchers/be_ok.rb
+- lib/blindfold/spec/monkey.rb
+- lib/blindfold/spec.rb
+- lib/blindfold/xml/monkey.rb
+- lib/blindfold/xml.rb
+- lib/blindfold.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- VERSION
+has_rdoc: true
+homepage: http://github.com/fallwith/blindfold
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: API/XML focused integration testing for Rack apps
+test_files: []
+