service_double 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 iain
+
+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,117 @@
+# Service Double
+
+A tool for making fake versions of external (web) services. You can use fake
+web services to return predicatable results for testing.
+
+What you need to do is create a small Sinatra application, that will play the
+fake version during your tests.
+
+By convention, the application should respond to two basic urls: `GET /` and
+`DELETE /`. The GET request is used to tell if the application is running. The
+DELETE request should reset the application, and is called between each
+test/scenario.
+
+An example of such a fake web service:
+
+``` ruby
+values = []
+
+get "/" do
+  200
+end
+
+delete "/" do
+  values.clear
+  200
+end
+
+post "/remember" do
+  values << params[:value]
+end
+
+get "/remembered" do
+  { :remembered => values }.to_json
+end
+```
+
+The idea is that inside this fake app, you can cheat all you like. Your
+database might be a simple hash or array, or you can choose to return simple
+canned responses.
+
+You can also add paths to your fake app that don't exist in the real app, which
+you can use for easy testing and debugging.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+group :test do
+  gem 'service_double', require: false
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service_double
+
+## Usage
+
+To hook it up to a test framework:
+
+``` ruby
+require 'service_double'
+
+ServiceDouble.hook_into(:cucumber) do |config|
+  config.server = "my_sinatra_server.rb"
+  config.url = "http://localhost:12345"
+end
+```
+
+Supported frameworks are currently `:cucumber` and `:rspec`.
+
+The configuration options are:
+
+* **server** where to find the fake web service app (required)
+* **url** where the fake web service should be accessed (required)
+* **timeout** how long you allow the fake server to take booting up (default: 2 seconds)
+* **log_file** where to write the server logs to (default: "log/#{server}.log")
+
+You can have one or multiple services doubles, and control them:
+
+``` ruby
+$widget_service = ServiceDouble.hook_into(:rspec) do |config|
+  config.server = "fake_widgets.rb"
+  config.url = "http://localhost:12345"
+end
+
+$weather_service = ServiceDouble.hook_into(:rspec) do |config|
+  config.server = "fake_weather.rb"
+  config.url = "http://localhost:12346"
+end
+
+# later on:
+
+$weather_service.post("/_stub_temp", :place => "New York", :temp => 22.4)
+```
+
+Here are some methods that can be called on the service objects:
+
+* **get** performs a GET request (maps to Faraday's `get` method)
+* **post** performs a POST request (like `get`)
+* **delete** etc...
+* **put** etc...
+* **post** etc...
+* **reset** sends `DELETE` request to `/` (is done automatically between tests)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :cucumber]

data/features/service_double.feature

@@ -0,0 +1,9 @@
+Feature: Service Double
+
+  Scenario: Remembering something
+    When I ask the fake server to remember "the fifth of November"
+    Then the fake server remembered to "the fifth of November"
+
+  Scenario: Forgetting everything between scenarios
+    When I am in a new scenario 
+    Then the fake server should remember nothing from the previous scenario

data/features/step_definitions/service_double_steps.rb

@@ -0,0 +1,17 @@
+When /^I ask the fake server to remember "(.*?)"$/ do |value|
+  $cucumber_server.post("/remember", :value => value)
+end
+
+Then /^the fake server remembered to "(.*?)"$/ do |value|
+  remembered = JSON.parse($cucumber_server.get("/remembered").body)
+  remembered.should eq "remembered" => [value]
+end
+
+When /^I am in a new scenario$/ do
+  # noop
+end
+
+Then /^the fake server should remember nothing from the previous scenario$/ do
+  remembered = JSON.parse($cucumber_server.get("/remembered").body)
+  remembered.should eq "remembered" => []
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'service_double'
+require 'json'
+
+$cucumber_server = ServiceDouble.hook_into :cucumber do |config|
+  config.server = File.expand_path("../../../spec/support/rspec_server.rb", __FILE__)
+  config.url = "http://localhost:8083"
+end

data/lib/service_double.rb

@@ -0,0 +1,38 @@
+require "service_double/version"
+
+module ServiceDouble
+
+  Error = Class.new(StandardError)
+  UnknownFramework = Class.new(Error)
+
+  require "service_double/manager"
+  require "service_double/configuration"
+
+  def self.hook_into(framework, &block)
+    require_relative "service_double/frameworks/#{framework}"
+    config = Configuration.new
+    yield config
+    manager = Manager.new(config)
+    managers << manager
+    manager
+  rescue LoadError
+    raise UnknownFramework, "No hooks provided for #{framework.inspect}."
+  end
+
+  def self.managers
+    @managers ||= []
+  end
+
+  def self.start
+    managers.each(&:start)
+  end
+
+  def self.stop
+    managers.each(&:stop)
+  end
+
+  def self.reset
+    managers.each(&:reset)
+  end
+
+end

data/lib/service_double/configuration.rb

@@ -0,0 +1,52 @@
+module ServiceDouble
+
+  NoURLSet   = Class.new(Error)
+  NoServerSet = Class.new(Error)
+  ServerNotFound = Class.new(Error)
+
+  class Configuration
+
+    attr_accessor :url, :log_file, :timeout, :server
+
+    def initialize
+      @url = nil
+      @server = nil
+      @log_file = nil
+      @timeout = 2
+    end
+
+    def url
+      @url || no_url_set!
+    end
+
+    def server=(path)
+      full = File.expand_path(path)
+      if File.exist?(full)
+        @server = full
+      else
+        raise ServerNotFound, "Cannot find server to run at #{full}"
+      end
+    end
+
+    def server
+      @server || no_server_set!
+    end
+
+    def log_file
+      @log_file || "log/#{name}.log"
+    end
+
+    def name
+      File.basename(server, ".rb")
+    end
+
+    def no_url_set!
+      raise NoURLSet, "No URL set for the fake shop."
+    end
+
+    def no_server_set!
+      raise NoServerSet, "No server option set."
+    end
+
+  end
+end

data/lib/service_double/frameworks/cucumber.rb

@@ -0,0 +1,11 @@
+AfterConfiguration do |config|
+  ServiceDouble.start
+end
+
+Before do
+  ServiceDouble.reset
+end
+
+at_exit do
+  ServiceDouble.stop
+end

data/lib/service_double/frameworks/rspec.rb

@@ -0,0 +1,15 @@
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    ServiceDouble.start
+  end
+
+  config.before(:each) do
+    ServiceDouble.reset
+  end
+
+  config.after(:suite) do
+    ServiceDouble.stop
+  end
+
+end

data/lib/service_double/manager.rb

@@ -0,0 +1,93 @@
+require 'faraday'
+require 'uri'
+require 'verbose_hash_fetch'
+require 'yaml'
+require 'json'
+require 'forwardable'
+require 'fileutils'
+
+module ServiceDouble
+
+  NotRunning = Class.new(Error)
+  NotStarted = Class.new(Error)
+  Timeout    = Class.new(Error)
+
+  class Manager
+
+    extend Forwardable
+
+    def_delegators :connection, :get, :post, :head, :delete, :put, :patch
+
+    attr_reader :root_url, :log_file, :started_at, :timeout, :server, :name
+
+    def initialize(config)
+      @root_url = config.url
+      @log_file = config.log_file
+      @timeout  = config.timeout
+      @server   = config.server
+      @name     = config.name
+    end
+
+    def start
+      FileUtils.mkdir_p(File.dirname(log_file)) if log_file.is_a?(String)
+      args = %w(ruby -r sinatra -r json) << server << "-p" << port
+      args << { :out => log_file, :err => log_file }
+      @pid = Process.spawn(*args)
+      @started_at = Time.now
+      wait until up?
+    end
+
+    def reset
+      delete("/")
+    end
+
+    def stop
+      if started?
+        Process.kill("TERM", @pid)
+        Process.waitpid(@pid)
+      end
+    end
+
+    def port
+      URI(root_url).port.to_s
+    end
+
+    def wait
+      unless timed_out?
+        sleep 0.01
+      else
+        raise Timeout, "It took more than #{timeout} seconds to start #{name}. Check the logs at #{log_file} to see why."
+      end
+    end
+
+    def up?
+      started? and running?
+    end
+
+    def started?
+      if @pid
+        Process.getpgid(@pid) rescue false
+      else
+        raise NotStarted, "The fake #{name} hasn't been started yet."
+      end
+    end
+
+    def running?
+      get("/").status == 200 rescue false
+    end
+
+    def timed_out?
+      Time.now - timeout > started_at
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: root_url) { |faraday|
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      }
+    end
+
+  end
+
+end

data/lib/service_double/version.rb

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

data/log/rspec_server.log

@@ -0,0 +1,26 @@
+[2013-03-05 15:36:55] INFO  WEBrick 1.3.1
+[2013-03-05 15:36:55] INFO  ruby 1.9.3 (2013-02-22) [x86_64-darwin12.2.0]
+== Sinatra/1.3.5 has taken the stage on 8083 for development with backup from WEBrick
+[2013-03-05 15:36:55] INFO  WEBrick::HTTPServer#start: pid=51710 port=8083
+127.0.0.1 - - [05/Mar/2013 15:36:55] "GET / HTTP/1.1" 200 - 0.0022
+localhost - - [05/Mar/2013:15:36:55 CET] "GET / HTTP/1.1" 200 0
+- -> /
+127.0.0.1 - - [05/Mar/2013 15:36:55] "DELETE / HTTP/1.1" 200 - 0.0003
+localhost - - [05/Mar/2013:15:36:55 CET] "DELETE / HTTP/1.1" 200 0
+- -> /
+127.0.0.1 - - [05/Mar/2013 15:36:55] "POST /remember HTTP/1.1" 200 21 0.0003
+localhost - - [05/Mar/2013:15:36:55 CET] "POST /remember HTTP/1.1" 200 21
+- -> /remember
+127.0.0.1 - - [05/Mar/2013 15:36:55] "GET /remembered HTTP/1.1" 200 40 0.0003
+localhost - - [05/Mar/2013:15:36:55 CET] "GET /remembered HTTP/1.1" 200 40
+- -> /remembered
+127.0.0.1 - - [05/Mar/2013 15:36:55] "DELETE / HTTP/1.1" 200 - 0.0002
+localhost - - [05/Mar/2013:15:36:55 CET] "DELETE / HTTP/1.1" 200 0
+- -> /
+127.0.0.1 - - [05/Mar/2013 15:36:55] "GET /remembered HTTP/1.1" 200 17 0.0002
+localhost - - [05/Mar/2013:15:36:55 CET] "GET /remembered HTTP/1.1" 200 17
+- -> /remembered
+
+== Sinatra has ended his set (crowd applauds)
+[2013-03-05 15:36:57] INFO  going to shutdown ...
+[2013-03-05 15:36:57] INFO  WEBrick::HTTPServer#start done.

data/service_double.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_double/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "service_double"
+  spec.version       = ServiceDouble::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+  spec.description   = %q{A tool for making fake versions of external (web) services.}
+  spec.summary       = %q{A tool for making fake versions of external (web) services.}
+  spec.homepage      = "https://github.com/yourkarma/service_double"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "sinatra"
+  spec.add_dependency "verbose_hash_fetch"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "cucumber"
+end

data/spec/service_double_spec.rb

@@ -0,0 +1,27 @@
+require 'service_double'
+require 'json'
+
+$rspec_server = ServiceDouble.hook_into :rspec do |config|
+  config.server = File.expand_path("../support/rspec_server.rb", __FILE__)
+  config.url = "http://localhost:8082"
+end
+
+describe ServiceDouble do
+
+  it "should be running" do
+    $rspec_server.should be_running
+  end
+
+  it "should receive requests" do
+    value = rand(10**26).to_s(26)
+    $rspec_server.post("/remember", value: value)
+    values = JSON.parse($rspec_server.get("/remembered").body)
+    values.should eq "remembered" => [value]
+  end
+
+  it "should not remember request from the previous test" do
+    values = JSON.parse($rspec_server.get("/remembered").body)
+    values.should eq "remembered" => []
+  end
+
+end

data/spec/support/rspec_server.rb

@@ -0,0 +1,18 @@
+values = []
+
+get "/" do
+  200
+end
+
+delete "/" do
+  values.clear
+  200
+end
+
+post "/remember" do
+  values << params[:value]
+end
+
+get "/remembered" do
+  { :remembered => values }.to_json
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: service_double
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: sinatra
+  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: verbose_hash_fetch
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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 tool for making fake versions of external (web) services.
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/service_double.feature
+- features/step_definitions/service_double_steps.rb
+- features/support/env.rb
+- lib/service_double.rb
+- lib/service_double/configuration.rb
+- lib/service_double/frameworks/cucumber.rb
+- lib/service_double/frameworks/rspec.rb
+- lib/service_double/manager.rb
+- lib/service_double/version.rb
+- log/rspec_server.log
+- service_double.gemspec
+- spec/service_double_spec.rb
+- spec/support/rspec_server.rb
+homepage: https://github.com/yourkarma/service_double
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: A tool for making fake versions of external (web) services.
+test_files:
+- features/service_double.feature
+- features/step_definitions/service_double_steps.rb
+- features/support/env.rb
+- spec/service_double_spec.rb
+- spec/support/rspec_server.rb