antilles 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+*.swp

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tddium.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    antilles (0.1.0)
+      bundler
+      daemons
+      httparty
+      json
+      mimic
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    daemons (1.1.4)
+    diff-lcs (1.1.3)
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    json (1.5.4)
+    mimic (0.4.3)
+      json
+      plist
+      rack
+      sinatra
+    plist (3.1.0)
+    rack (1.3.2)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sinatra (1.2.6)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  antilles!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2011 Solano Labs, Inc.
+
+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.md

@@ -0,0 +1,44 @@
+# Antilles
+
+## Overview
+
+Antilles sets up a stub HTTP server using mimic and exposes a simple interface
+to configure the server.  Antilles is meant to work with aruba to make it easier
+to test command line tools that communicate with Web APIs. 
+
+## Installation
+
+Antilles works best with cucumber, but it can be used with any testing tool.
+
+### Install the gem:
+
+      gem install antilles
+
+   or use bundler:
+
+      group :test do
+        gem :antilles
+      end
+
+### Set up environment:
+
+      # features/support/antilles.rb
+      require 'antilles/cucumber'
+
+      Antilles.configure do |server|
+        server.port = 9876   # defaults to 8080
+        server.log = STDOUT  # defaults to nil for no logging
+      end
+
+Requiring `antilles/cucumber` will automatically start a server before all
+Scenarios tagged `@mimic`, and tear down the server when the test exits.
+
+## Usage
+
+Antilles can be configured to do anything mimic can do, but the basic mode of
+operation is to `install` stubs:
+
+    Given /^creating a membership fails with: (.*)$/ do |error|
+      user="a@b.com"
+      Antilles.install(:post, "/memberships/#{user}", {:status=>1, :explanation=>error}, :code=>409)
+    end

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = "--color"
+end
+task :default => :spec
+

data/antilles.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "antilles/version"
+
+Gem::Specification.new do |s|
+  s.name        = "antilles"
+  s.version     = AntillesVersion::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Solano Labs"]
+  s.email       = ["info@tddium.com"]
+  s.homepage    = "http://www.tddium.com/"
+  s.summary     = %q{Easy API Mimicing for Cucumber}
+  s.description = <<-EOF
+Antilles uses Mimic to set up a stub HTTP server that a CLI tool being tested
+with cucumber/aruba can communicate with.
+EOF
+
+  s.rubyforge_project = "tddium"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("json")
+  s.add_runtime_dependency("bundler")
+  s.add_runtime_dependency("mimic")
+  s.add_runtime_dependency("httparty")
+  s.add_runtime_dependency("daemons")
+
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("rake")
+end

data/lib/antilles.rb

@@ -0,0 +1,117 @@
+require 'rubygems'
+require 'mimic'
+require 'timeout'
+require 'daemons'
+require 'httparty'
+
+class Antilles
+  attr_accessor :port
+  attr_accessor :log
+
+  def initialize(port=nil, log=nil)
+    @port = port || 8080
+    @pid_list = []
+    @log = log
+  end
+
+  def started?
+    @pid_list.size > 0
+  end
+
+  def start
+    pid = Kernel.fork
+    if pid.nil? then
+      args = {:fork => false,
+              :host => 'localhost',
+              :port => @port,
+              :remote_configuration_path => '/api'}
+      args[:log] = @log if @log
+      Mimic.mimic(args) do
+        [:INT, :TERM].each { |sig| trap(sig) { Kernel.exit!(0) } }
+      end
+      Kernel.exit!(0)
+    end
+    @pid_list.push(pid)
+    wait
+  end
+
+  def stop
+    @pid_list.each do |pid|
+      Process.kill("TERM", pid)
+    end
+    @pid_list = []
+  end
+
+  def wait
+    5.times do
+      if ping then
+        break
+      end
+      Kernel.sleep(0.1)
+    end
+  end
+
+  def ping
+    begin
+      http = call_api(:get,  '/api/ping')
+    rescue Exception, Timeout::Error
+      return false
+    end
+    return http.code == 200
+  end
+
+  def clear
+    http = call_api(:post,  '/api/clear')
+    return http
+  end
+
+  def install(verb, path, body, options={})
+    api_headers = options.delete(:api_headers)
+    params = { 'path' => path, 'body' => body.to_json }.merge(options)
+    http = call_api(:post,  "/api/#{verb}", params.to_json, api_headers)
+    return http
+  end
+
+  def call_api(method, path, params = {}, headers = {})
+    tries = 0
+    retries = 7
+    done = false
+    while (tries <= retries) && !done
+      begin
+        http = HTTParty.send(method, "http://localhost:#{@port}#{path}",
+                             :body => params, :headers => headers)
+        done = true
+      rescue SystemCallError
+        Kernel.sleep(0.5)
+      rescue Timeout::Error
+        Kernel.sleep(0.5)
+      ensure
+        tries += 1
+      end
+    end
+    raise Timeout::Error if tries > retries && retries >= 0
+    return http
+  end
+
+  class << self
+    def configure(&block)
+      yield server 
+    end
+
+    def start
+      return server if server.started?
+      server.start
+      server
+    end
+
+    def server
+      @server ||= Antilles.new
+      @server
+    end
+
+    def clear
+      @server.clear rescue nil
+    end
+  end
+end
+

data/lib/antilles/cucumber.rb

@@ -0,0 +1,12 @@
+Before('@mimic') do
+  MimicServer.start
+end
+
+After('@mimic') do
+  MimicServer.clear
+end
+
+at_exit do
+  server = MimicServer.server
+  server.stop if server
+end

data/lib/antilles/version.rb

@@ -0,0 +1,3 @@
+module AntillesVersion
+  VERSION = '0.1.0'
+end

data/spec/antilles_spec.rb

@@ -0,0 +1,128 @@
+require "spec_helper"
+
+describe Antilles do
+  SAMPLE_PID = 12345
+  SAMPLE_PORT = 12346
+  SAMPLE_MIMIC_ARGS = {:fork => false,
+                       :host => 'localhost',
+                       :port => SAMPLE_PORT,
+                       :remote_configuration_path => "/api"}
+
+
+  describe ".configure" do
+    it "should yield an object that can set port and log" do
+      Antilles.configure do |server|
+        server.port = 9875
+        server.log = STDERR
+      end
+      Antilles.server.port.should == 9875
+      Antilles.server.log.should == STDERR
+    end
+  end
+
+  describe ".server" do
+    it "should return an Antilles" do
+      Antilles.server.should be_a(Antilles)
+    end
+
+    it "should save what it creates" do
+      s1 = Antilles.server
+      s2 = Antilles.server
+      s1.should == s2
+    end
+  end
+
+  describe ".start" do
+    let(:server) { mock(Antilles) }
+    it "should start a server" do
+      server.stub(:start)
+      server.stub(:started?) { false }
+      server.should_receive(:start)
+      Antilles.stub(:server) { server }
+
+      Antilles.start
+    end
+
+    it "should not start a server if it's already started" do
+      server.stub(:start)
+      server.stub(:started?) { true }
+      server.should_not_receive(:start)
+      Antilles.stub(:server) { server }
+
+      Antilles.start
+    end
+  end
+
+  describe "#new" do
+    it "should set port and log" do
+      s = Antilles.new(10)
+      s.port.should == 10
+      s = Antilles.new(10, STDERR)
+      s.port.should == 10
+      s.log.should == STDERR
+    end
+  end
+
+  def stub_start
+    Kernel.stub(:fork) { SAMPLE_PID }
+    Process.stub(:kill).with("TERM", SAMPLE_PID)
+    Kernel.stub(:exit!)
+    Mimic.stub(:mimic)
+    Antilles.any_instance.stub(:wait)
+  end
+
+  describe "#started?" do
+    before { stub_start }
+    it "should start false" do
+      subject.should_not be_started
+    end
+
+    it "should be true after starting the server" do
+      subject.start
+      subject.should be_started
+    end
+
+    it "should be false after stopping the server" do
+      subject.start
+      subject.stop
+      subject.should_not be_started
+    end
+  end
+
+  describe "#start" do
+    subject { Antilles.new(SAMPLE_PORT) }
+
+    before do
+      Kernel.stub(:fork) { nil }
+      Mimic.stub(:mimic)
+      Kernel.stub(:exit!)
+      subject.stub(:wait)
+    end
+
+    it "should start mimic on the right port" do
+      Mimic.should_receive(:mimic).with(SAMPLE_MIMIC_ARGS)
+      subject.start
+    end
+
+    it "should start mimic with the log set" do
+      Mimic.should_receive(:mimic).with(SAMPLE_MIMIC_ARGS.merge(:log=>STDERR))
+      subject.log = STDERR
+      subject.start
+    end
+  end
+
+  describe "#wait" do
+    before { Kernel.stub(:sleep) }
+    it "should ping" do
+      subject.stub(:ping) { true }
+      subject.should_receive(:ping).once
+      subject.wait
+    end
+
+    it "should retry" do
+      subject.stub(:ping) { false }
+      subject.should_receive(:ping).exactly(5).times
+      subject.wait
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "antilles"
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: antilles
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Solano Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mimic
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: |
+  Antilles uses Mimic to set up a stub HTTP server that a CLI tool being tested
+  with cucumber/aruba can communicate with.
+
+email: 
+- info@tddium.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- antilles.gemspec
+- lib/antilles.rb
+- lib/antilles/cucumber.rb
+- lib/antilles/version.rb
+- spec/antilles_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.tddium.com/
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: tddium
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Easy API Mimicing for Cucumber
+test_files: []
+