skink 0.1.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Todd Thomas
+
+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,5 @@
+# Skink
+
+Skink is Capybara's smaller, more primitive companion. Button-clicking
+and JavaScript are beyond Skink's intellectual abilities, but Skink is
+happy to help test your REST API.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/skink/client/base.rb

@@ -0,0 +1,87 @@
+require 'skink'
+
+module Skink
+module Client
+
+class Base
+  def with_header(name, value)
+    raise NotImplementedError
+  end
+
+  def with_basic_auth(user_name, email_address)
+    raise NotImplementedError
+  end
+
+  def head(path)
+    raise NotImplementedError
+  end
+
+  def get(path)
+    raise NotImplementedError
+  end
+
+  def post(path, body = nil)
+    raise NotImplementedError
+  end
+
+  def put(path, body)
+    raise NotImplementedError
+  end
+
+  def delete(path)
+    raise NotImplementedError
+  end
+
+  def trace(path)
+    raise NotImplementedError
+  end
+
+  def options(path)
+    raise NotImplementedError
+  end
+
+  def connect(path)
+    raise NotImplementedError
+  end
+
+  def patch(path, body = nil)
+    raise NotImplementedError
+  end
+
+  def response
+    raise NotImplementedError
+  end
+
+  def method_missing(name, *args)
+    if name.match(/with_(\w+)_header/)
+      with_header(normalize_header_name($1), *args)
+    else
+      super
+    end
+  end
+
+private
+  def normalize_header_name(name)
+    # c.f http://en.wikipedia.org/wiki/List_of_HTTP_header_fields
+
+    case name
+    # special cases
+    when /^content_md5$/i
+      return "Content-MD5"
+    when /^te$/i
+      return "TE"
+    when /^dnt$/i
+      return "DNT"
+    when /^etag$/i
+      return "ETag"
+    when /^www_authenticate$/i
+      return "WWW-Authenticate"
+    end
+
+    # otherwise this should work
+    name.split("_").map(&:capitalize).join("-")
+  end
+end
+
+end
+end

data/lib/skink/client/response.rb

@@ -0,0 +1,15 @@
+module Skink
+module Client
+
+class Response
+  def status_code
+    raise NotImplementedError
+  end
+
+  def body
+    raise NotImplementedError
+  end
+end
+
+end
+end

data/lib/skink/dsl.rb

@@ -0,0 +1,50 @@
+require 'skink'
+require 'skink/client/base'
+require 'skink/rack_test_client/rack_test_client'
+require 'skink/resourceful_client/resourceful_client'
+
+module Skink
+  class << self
+    attr_writer :rack_app
+    attr_accessor :base_url
+
+    def rack_app
+      raise ConfigurationError.new "You must set Skink.rack_app to use the DSL." unless @rack_app
+      @rack_app
+    end
+
+    def client
+      @client ||= new_client
+    end
+
+    def new_client
+      if base_url.nil? || base_url.empty?
+        RackTestClient.new(rack_app)
+      else
+        ResourcefulClient.new(base_url)
+      end
+    end
+
+    def reset_client!
+      @client = nil
+    end
+  end
+
+  module DSL
+    def self.included(base)
+      puts "Skink::DSL being included in #{base.inspect}"
+    end
+
+    def self.extended(base)
+      puts "Skink::DSL extending #{base.inspect}"
+    end
+
+    Skink::Client::Base.instance_methods(false).each do |method|
+      define_method method do |*args, &block|
+        Skink.client.send method, *args, &block
+      end
+    end
+  end
+
+  extend Skink::DSL
+end

data/lib/skink/integrations/rails.rb

@@ -0,0 +1,12 @@
+require 'skink/dsl'
+
+Skink.rack_app = Rack::Builder.new do
+  map "/" do
+    if Rails.version.to_f >= 3.0
+      run Rails.application
+    else # Rails 2
+      use Rails::Rack::Static
+      run ActionController::Dispatcher.new
+    end
+  end
+end.to_app

data/lib/skink/integrations/rspec.rb

@@ -0,0 +1,11 @@
+require 'skink/dsl'
+
+RSpec.configure do |config|
+  config.include Skink::DSL
+
+  config.after do
+    if self.class.include?(Skink::DSL)
+      Skink.reset_client!
+    end
+  end
+end

data/lib/skink/rack_test_client/rack_test_client.rb

@@ -0,0 +1,55 @@
+require 'skink/client/base'
+require 'skink/rack_test_client/rack_test_response'
+
+require 'rack/test'
+
+module Skink
+
+class RackTestClient < Client::Base
+  include Rack::Test::Methods
+
+  attr_reader :app, :last_response
+
+  def initialize(rack_app)
+    @app = rack_app
+  end
+
+  def with_basic_auth(user_name, password)
+    authorize(user_name, password)
+  end
+
+  def with_header(name, value)
+    header(name, value)
+  end
+
+  def head(path)
+    resp = super path
+    @last_response = RackTestResponse.new resp
+  end
+
+  def get(path)
+    resp = super path
+    @last_response = RackTestResponse.new resp
+  end
+
+  def post(path, body = nil)
+    resp = super(path, body)
+    @last_response = RackTestResponse.new resp
+  end
+
+  def put(path, body)
+    resp = super(path, body)
+    @last_response = RackTestResponse.new resp
+  end
+
+  def delete(path)
+    resp = super path
+    @last_response = RackTestResponse.new resp
+  end
+
+  def response
+    last_response
+  end
+end
+
+end

data/lib/skink/rack_test_client/rack_test_response.rb

@@ -0,0 +1,21 @@
+require 'skink/client/response'
+
+module Skink
+
+class RackTestResponse < Client::Response
+  attr_reader :native_response
+
+  def initialize(native_response)
+    @native_response = native_response
+  end
+
+  def status_code
+    native_response.status
+  end
+
+  def body
+    native_response.body
+  end
+end
+
+end

data/lib/skink/resourceful_client/resourceful_client.rb

@@ -0,0 +1,85 @@
+require 'skink/client/base'
+require 'skink/resourceful_client/resourceful_response'
+
+require 'resourceful'
+require 'httpauth'
+
+module Skink
+
+class ResourcefulClient < Client::Base
+  attr_reader :base_url, :headers, :http_accessor, :last_response
+
+  def initialize(base_url)
+    @base_url = base_url
+    @headers = {}
+  end
+
+  def http_accessor
+    @http_accessor ||= Resourceful::HttpAccessor.new
+  end
+
+  def with_basic_auth(user_name, password)
+    #http_accessor.add_authenticator Resourceful::PromiscuousBasicAuthenticator.new(user_name, password)
+    http_accessor.add_authenticator Resourceful::BasicAuthenticator.new("Restricted Area", user_name, password)
+  end
+
+  def with_header(name, value)
+    headers.merge! name => value
+  end
+
+  def head(path)
+    begin
+      resp = http_accessor.resource(base_url + path).head(headers)
+    rescue Resourceful::UnsuccessfulHttpRequestError => e
+      resp = e.http_response
+    end
+
+    @last_response = ResourcefulResponse.new resp
+  end
+
+  def get(path)
+    begin
+      resp = http_accessor.resource(base_url + path).get(headers)
+    rescue Resourceful::UnsuccessfulHttpRequestError => e
+      resp = e.http_response
+    end
+
+    @last_response = ResourcefulResponse.new resp
+  end
+
+  def post(path, body = nil)
+    begin
+      resp = http_accessor.resource(base_url + path).post(body, headers)
+    rescue Resourceful::UnsuccessfulHttpRequestError => e
+      resp = e.http_response
+    end
+
+    @last_response = ResourcefulResponse.new resp
+  end
+
+  def put(path, body)
+    begin
+      resp = http_accessor.resource(base_url + path).put(body, headers)
+    rescue Resourceful::UnsuccessfulHttpRequestError => e
+      resp = e.http_response
+    end
+
+    @last_response = ResourcefulResponse.new resp
+  end
+
+  def delete(path)
+    begin
+      resp = http_accessor.resource(base_url + path).delete(headers)
+    rescue Resourceful::UnsuccessfulHttpRequestError => e
+      resp = e.http_response
+    end
+
+    @last_response = ResourcefulResponse.new resp
+  end
+
+  def response
+    last_response
+  end
+end
+
+end

data/lib/skink/resourceful_client/resourceful_response.rb

@@ -0,0 +1,21 @@
+require 'skink/client/response'
+
+module Skink
+
+class ResourcefulResponse < Client::Response
+  attr_reader :native_response
+
+  def initialize(native_response)
+    @native_response = native_response
+  end
+
+  def status_code
+    native_response.code
+  end
+
+  def body
+    native_response.body || ""
+  end
+end
+
+end

data/lib/skink/version.rb

@@ -0,0 +1,3 @@
+module Skink
+  VERSION = "0.1.0"
+end

data/lib/skink.rb

@@ -0,0 +1,5 @@
+require "skink/version"
+
+module Skink
+  class ConfigurationError < RuntimeError; end
+end

data/skink.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skink/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "skink"
+  gem.version       = Skink::VERSION
+  gem.authors       = ["Todd Thomas"]
+  gem.email         = ["todd.thomas@openlogic.com"]
+  gem.description   = %q{A DSL for testing REST APIs}
+  gem.summary       = %q{Skink is Capybara's smaller, more primitive companion.}
+  gem.homepage      = ""
+
+  gem.add_dependency "rack-test"
+  gem.add_dependency "openlogic-resourceful"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sinatra"
+
+  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.require_paths = ["lib"]
+end

data/spec/skink_dsl_spec.rb

@@ -0,0 +1,65 @@
+require_relative './spec_helper'
+
+shared_examples "a REST API test language" do
+  it "is able to test a HEAD" do
+    head "/"
+    response.status_code.should == 200
+    response.body.size.should == 0
+  end
+
+  it "is able to test a GET" do
+    get "/"
+    response.status_code.should == 200
+    response.body.should == "Hello, world!"
+  end
+
+  it "is able to test a POST" do
+    body = "<ping/>"
+    with_content_type_header "application/xml"
+    post "/", body
+    response.status_code.should == 200
+    response.body.should == body
+  end
+
+  it "is able to test a PUT" do
+    body = "{\"ping\": \"hello\"}"
+    with_content_type_header "application/json"
+    put "/", body
+    response.status_code.should == 200
+    response.body.should == body
+  end
+
+  it "is able to test a DELETE" do
+    delete "/"
+    response.status_code.should == 200
+    response.body.should == "Deleted"
+  end
+
+  it "is able to test a request with additional headers" do
+    with_accept_header "application/json"
+    get "/foo"
+    response.status_code.should == 200
+    response.body.should == "{\"foo\": 42}"
+  end
+
+  it "is able to test requests which require basic authentication" do
+    get "/protected"
+    response.status_code.should == 401
+
+    with_basic_auth "admin", "admin"
+    get "/protected"
+    response.status_code.should == 200
+    response.body.should == "Welcome, authenticated client."
+  end
+end
+
+describe Skink::DSL do
+  context "using rack_test" do
+    it_behaves_like "a REST API test language"
+  end
+
+  context "using Resourceful" do
+    before { Skink.base_url = "http://localhost:4567" }
+    it_behaves_like "a REST API test language"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+__DIR__ = File.dirname(__FILE__)
+
+$LOAD_PATH << File.join(__DIR__, "..", "lib")
+
+require 'skink/integrations/rspec'
+
+RSpec.configure do |config|
+  config.include Skink::DSL
+end
+
+require 'test_server'
+Skink.rack_app = Rack::Builder.new do
+  map "/" do
+    run Sinatra::Application
+  end
+end.to_app
+
+# Start "remote" test server in another thread.
+@server = Thread.new do
+  Sinatra::Application.run!
+end
+
+# Kill the server process when rspec finishes.
+at_exit { @server.exit }
+
+# Let the server start up.
+sleep 1

data/spec/test_server.rb

@@ -0,0 +1,40 @@
+require 'sinatra'
+
+helpers do
+  def protected!
+    unless authorized?
+      response['WWW-Authenticate'] = %(Basic realm="Restricted Area")
+      throw(:halt, [401, "Not authorized\n"])
+    end
+  end
+
+  def authorized?
+    @auth ||=  Rack::Auth::Basic::Request.new(request.env)
+    @auth.provided? && @auth.basic? && @auth.credentials && @auth.credentials == ['admin', 'admin']
+  end
+end
+
+get '/' do
+  "Hello, world!"
+end
+
+post '/' do
+  request.body
+end
+
+put '/' do
+  request.body
+end
+
+delete '/' do
+  "Deleted"
+end
+
+get '/foo', :provides => :json do
+  "{\"foo\": 42}"
+end
+
+get '/protected' do
+  protected!
+  "Welcome, authenticated client."
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: skink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Todd Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: openlogic-resourceful
+  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: 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: sinatra
+  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 DSL for testing REST APIs
+email:
+- todd.thomas@openlogic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/skink.rb
+- lib/skink/client/base.rb
+- lib/skink/client/response.rb
+- lib/skink/dsl.rb
+- lib/skink/integrations/rails.rb
+- lib/skink/integrations/rspec.rb
+- lib/skink/rack_test_client/rack_test_client.rb
+- lib/skink/rack_test_client/rack_test_response.rb
+- lib/skink/resourceful_client/resourceful_client.rb
+- lib/skink/resourceful_client/resourceful_response.rb
+- lib/skink/version.rb
+- skink.gemspec
+- spec/skink_dsl_spec.rb
+- spec/spec_helper.rb
+- spec/test_server.rb
+homepage: ''
+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: Skink is Capybara's smaller, more primitive companion.
+test_files:
+- spec/skink_dsl_spec.rb
+- spec/spec_helper.rb
+- spec/test_server.rb