shamrock 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shamrock.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Justin S. Leitgeb
+
+MIT License
+
+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,49 @@
+# Shamrock
+
+Makes setting up stub services easy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shamrock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shamrock
+
+## Usage
+
+You can then easily start the stub service either for the spec examples that need it, or
+globally in your spec_helper file. You can replace the Proc below with any Rack application.
+In some cases, we use Sinatra for stub services.
+
+my_rack_app = proc {|env| [200, {"Content-Type" => "text/html"}, "Hello Rack!"]}
+@service = Shamrock::Service.new(my_rack_app)
+@service.start
+
+After you are done with the service:
+
+@service.stop
+
+## Credits
+
+Thanks to Wojciech Mach (http://github.com/wojtekmach) who helped to implement something like
+this for a stub service on a project for Stack Builders.
+
+Thanks to Mike Barinek for writing up an example of this code that used Threads for starting
+the rack application - this gem draws from code in his blog post at
+http://pivotallabs.com/users/mbarinek/blog/articles/2043-testing-ruby-services-without-mocks
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/shamrock/monitor.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+require 'timeout'
+
+module Shamrock
+  class Monitor
+
+    DEFAULT_TIMEOUT = 10
+    RE_CHECK_WAIT   = 0.1
+
+    def initialize(url)
+      @uri = URI.parse(url)
+    end
+
+    def wait_until_ready
+      Timeout::timeout(DEFAULT_TIMEOUT) do
+        until server_started? do
+          sleep RE_CHECK_WAIT
+        end
+      end
+
+      puts "Started server #{server_name} on #{port.number}."
+
+    rescue Timeout::Error => error
+      abort "Server never started!"
+    end
+
+    def ready?
+      begin
+        response = Net::HTTP.get_response(@uri)
+        response.is_a?(Net::HTTPSuccess)
+      rescue SystemCallError => error
+        false
+      end
+    end
+
+    private
+
+    def server_name
+      @rack_app.class.name
+    end
+
+  end
+end

data/lib/shamrock/port.rb

@@ -0,0 +1,9 @@
+module Shamrock
+  class Port
+    attr_reader :number
+
+    def initialize
+      @number = Random.rand(9220...9239)
+    end
+  end
+end

data/lib/shamrock/service.rb

@@ -0,0 +1,28 @@
+module Shamrock
+  class Service
+    attr_reader :port, :url
+
+    def initialize(rack_app,
+                   handler = Rack::Handler::WEBrick,
+                   monitor = Shamrock::Monitor)
+
+      @rack_app = rack_app
+      @handler  = handler
+      @port     = Port.new
+      @url      = "http://localhost:#{port.number}"
+      @monitor  = monitor.new(url)
+    end
+
+    def start
+      @thread = Thread.new do
+        @handler.run(@rack_app, Port: port.number)
+      end
+
+      @monitor.wait_until_ready
+    end
+
+    def stop
+      Thread.kill(@thread)
+    end
+  end
+end

data/lib/shamrock/version.rb

@@ -0,0 +1,3 @@
+module Shamrock
+  VERSION = "0.0.1"
+end

data/lib/shamrock.rb

@@ -0,0 +1,6 @@
+require 'rack'
+
+require 'shamrock/version'
+require 'shamrock/port'
+require 'shamrock/service'
+require 'shamrock/monitor'

data/shamrock.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/shamrock/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin S. Leitgeb"]
+  gem.email         = ["justin@stackbuilders.com"]
+  gem.summary       = "Facilitates setting up stub services in your application"
+  gem.description   = "Shamrock helps you to use stub services in your application by starting a rack service in a Thread"
+
+  gem.homepage      = "http://github.com/jsl/shamrock"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "shamrock"
+  gem.require_paths = ["lib"]
+  gem.version       = Shamrock::VERSION
+
+  gem.add_dependency('rack')
+
+  gem.add_development_dependency 'rake', '~> 0.9.2.2'
+  gem.add_development_dependency 'rspec', '~> 2.10.0'
+  gem.add_development_dependency 'simplecov', '~> 0.6.4'
+end

data/spec/shamrock/port_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Shamrock::Port do
+  describe "initialization" do
+    it "should set a number" do
+      subject.number.should be_a(Integer)
+    end
+  end
+end

data/spec/shamrock/service_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Shamrock::Service do
+  before do
+    @rack_app = proc {|env| [200, {"Content-Type" => "text/html"}, "Hello Rack!"]}
+    @monitor = mock('monitor', wait_until_ready: true)
+    @monitor_class = mock('monitor class', new: @monitor)
+  end
+
+  describe "#start" do
+    it "should start the server" do
+      handler = mock('handler')
+      service = Shamrock::Service.new(@rack_app, handler, @monitor_class)
+      handler.should_receive(:run).with(@rack_app, Port: service.port.number)
+      service.start
+    end
+
+    it "should wait for the server to become available" do
+      @monitor.should_receive(:wait_until_ready).once
+      handler = mock('handler', run: true)
+      Shamrock::Service.new(@rack_app, handler, @monitor_class).start
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'shamrock'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: shamrock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin S. Leitgeb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+description: Shamrock helps you to use stub services in your application by starting
+  a rack service in a Thread
+email:
+- justin@stackbuilders.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/shamrock.rb
+- lib/shamrock/monitor.rb
+- lib/shamrock/port.rb
+- lib/shamrock/service.rb
+- lib/shamrock/version.rb
+- shamrock.gemspec
+- spec/shamrock/port_spec.rb
+- spec/shamrock/service_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jsl/shamrock
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Facilitates setting up stub services in your application
+test_files:
+- spec/shamrock/port_spec.rb
+- spec/shamrock/service_spec.rb
+- spec/spec_helper.rb