apirunner 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,9 +1,89 @@
 = apirunner
 
-Description goes here.
+*apirunner* let's you test your _JSON_ _API_ from the outside. Sometimes model-, controlle-r and routing-test's are not enough, you want to send requests to your application and validate the response in ganular detail. Then apirunner will be your best friend.
+
+apirunner is no replacement to rspec or cucumber tests, nor does it replace webrat or capable tools like that. It's an addition that lets you query you API, specify your queries in detail, parse the expected response code, message, header and body and compare all (or any) of 'em to your expectation.
+
+The request and expectation can (and have to be) written down in easily createable YAML Files. The provided expectation matchers can match strings, integers and regular expressions. So apirunner provides you with a simple but powerful tool to examine your api's bugs.
+
+apirunner was initially developed for testing of the mighty (m8ty) i18n recommendation engine showcase of moviepilot.com (http://www.moviepilot.com) and extracted and gem'ified afterwards.
+
+== Capabilities
+
+*apirunner* *can*:
+
+* be configured for as many environemnts as you wish (your local machine, you staging environment, your production boxes, your wifes handbag)
+* send GET, POST, PUT and DELETE requests via HTTP
+* read as many testcases as you wish from YAML files and execute them in the order of file appearance
+* read more then one testcase from a file
+* match the response code's of your applications responses
+* match the syntactical correctnes of the response format (as long as it is JSON)
+* proof the occurance and match the content of your app's HTTP header
+* proof the occurence and match the content of your app's Body (as long as it responds JSON)
+* optionally match only parts of header / body (you dont have to specify them in more detail than you are interested in)
+* exclude certain value test's from certain environments (by reading excludes from excludes.yml)
+* provide you with some nice feedback at the console .... yeah sexy dots (".") and fancy F's ("F") ....
+* print out a nice error report (that you as a awesome ruby coder will never see)
+* be invoked from within rake to generate some example configuration and testcase files
+* be invoked also from within rake to run your test's
+
+== Installation
+
+  gem install apirunner
+
+== Configuration
+
+  rake api::scaffold
+
+The latter one generates a starter configuration file in your config directory:
+
+  config/api_runner.yml
+
+Additionally there will be some example testcases which can be found in:
+
+  test/apirunner/001_create_ressource.yml
+  test/apirunner/002_delete_ressource.yml
+  test/apirunner/excludes.yml
+
+== Invocation
+
+Assuming you defined an environment "local" and "staging" you can invoke your masterpiece with:
+
+  rake api:run:local
+
+and
+
+  rake api:run:staging
+
+== Testing
+
+There are rspec model tests for all classes which can be invoked via:
+
+  rspec spec
+
+== Dependencies
+
+apirunner heavily depends on the following great GEM's:
+
+1) nokogiri
+2) httparty
+
+== Authors
+
+apirunner was written by:
+
+*Jan* *Roesner* (http://railspotting.de) (jan@roesner.it)
+
+for the great guy's at moviepilot.com (http://www.moviepilot.com)
+
+With support from:
+
+*Daniel* *Bornkessel* (daniel@moviepilot.com)
+
+and the *moviepilot* *dev-team* (developers@moviepilot.com)
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/apirunner.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apirunner}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["moviepilot"]

data/lib/api_runner.rb

@@ -5,7 +5,7 @@ class ApiRunner
 
   # initializes the object, loads environment, build base_uri
   def initialize(env)
-    @http_client = HttpClient.new
+    @http_client11 = HttpClient.new
     @spec = []
     @errors = []
     @excludes = []

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - moviepilot
@@ -245,7 +245,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3440094753525714403
+      hash: -1083630349754663416
       segments: 
       - 0
       version: "0"