apirunner 0.1.5 → 0.1.6

data/Gemfile

@@ -7,7 +7,8 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 
 gem 'nokogiri', '~> 1.4.3.1'
-gem 'httparty', '~> 0.6.1'
+#gem 'httparty', '~> 0.6.1'
+gem 'rest-client', '>= 1.6.1'
 
 group :development do
   gem "rspec", ">= 2.0.0.beta.19"

data/Gemfile.lock

@@ -2,7 +2,6 @@ GEM
   remote: http://rubygems.org/
   specs:
     builder (2.1.2)
-    crack (0.1.8)
     cucumber (0.8.5)
       builder (~> 2.1.2)
       diff-lcs (~> 1.1.2)
@@ -13,18 +12,19 @@ GEM
     gherkin (2.1.5)
       trollop (~> 1.16.2)
     git (1.2.5)
-    httparty (0.6.1)
-      crack (= 0.1.8)
     jeweler (1.5.0.pre3)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
     json_pure (1.4.6)
+    mime-types (1.16)
     mocha (0.9.8)
       rake
     nokogiri (1.4.3.1)
     rake (0.8.7)
     rcov (0.9.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
     rspec (2.0.0.beta.22)
       rspec-core (= 2.0.0.beta.22)
       rspec-expectations (= 2.0.0.beta.22)
@@ -44,9 +44,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   cucumber
-  httparty (~> 0.6.1)
   jeweler (~> 1.5.0.pre3)
   mocha (>= 0.9.8)
   nokogiri (~> 1.4.3.1)
   rcov
+  rest-client (>= 1.6.1)
   rspec (>= 2.0.0.beta.19)

data/README.rdoc

@@ -26,6 +26,7 @@ apirunner was initially developed for testing of the mighty (m8ty) i18n recommen
 * 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
+* not travel to Ibiza
 
 == Installation
 
@@ -45,6 +46,44 @@ Additionally there will be some example testcases which can be found in:
   test/apirunner/002_delete_ressource.yml
   test/apirunner/excludes.yml
 
+At first take some time and change config/api_runner.yml to your needs. You might for example want to test your app locally on localhost:3000, on staging machine and on production environment too. So your api_runner.yml could look like that:
+
+  local:
+    protocol: http
+    host: localhost
+    port: 3000
+    namespace: api
+  staging:
+    protocol: http
+    host: staging.yourstagingdomain.dom
+    port: 80
+    namespace: api
+  production:
+    protocol: https
+    host: www.yourproductiondomain.dom
+    port: 80
+    namespace: prod_api
+
+Take a look at "namespace" here. It makes the expectation matcher build ressource URI's like so:
+
+  http://localhost:3000/api
+  http://staging.yourstagingdomain.dom/api
+  http://www.yourproductiondomain.dom/prod_api
+
+The ressource pathes are simply appended before the request is sent.
+
+The file also generates your rake tasks dynamically. The above config will generate 3 new tasks:
+
+  api:run:local
+  api:run:staging
+  api:run:production
+
+== Excludes
+
+You may also want to define some excludes for some of your environment. Imageine on your localhost's server there is no "Last-Modified" present in the header, but you would like to check that on staging and production boxes.
+
+Simply define your story to check "Last-Modified" generally and exclude it for 
+
 == Invocation
 
 Assuming you defined an environment "local" and "staging" you can invoke your masterpiece with:
@@ -68,6 +107,18 @@ apirunner heavily depends on the following great GEM's:
 1) nokogiri
 2) httparty
 
+== Examples
+
+After invoking:
+
+  rake api:scaffold
+
+you will find some YAML example files for request and expectation generation in test/api_runner. You can create as many story files here as you like, they are executed in the order they are read from the filesystem, so you should name them like 000_create_some_ressource.yml, 001_read_some_ressource.yml and so on. 
+
+Alternatively you can place all your stories into one single file.
+
+Addition
+
 == Authors
 
 apirunner was written by:

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/apirunner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apirunner}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jan@moviepilot.com"]
-  s.date = %q{2010-09-22}
+  s.date = %q{2010-09-23}
   s.description = %q{apirunner is a testsuite to query your RESTful JSON API and match response with your defined expectations}
   s.email = %q{developers@moviepilot.com}
   s.extra_rdoc_files = [
@@ -63,7 +63,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
-      s.add_runtime_dependency(%q<httparty>, ["~> 0.6.1"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.6.1"])
       s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -77,7 +77,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
-      s.add_dependency(%q<httparty>, ["~> 0.6.1"])
+      s.add_dependency(%q<rest-client>, [">= 1.6.1"])
       s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
       s.add_dependency(%q<cucumber>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -92,7 +92,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
-    s.add_dependency(%q<httparty>, ["~> 0.6.1"])
+    s.add_dependency(%q<rest-client>, [">= 1.6.1"])
     s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
     s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

data/examples/test/api_runner/001_create_ressource.yml

@@ -5,13 +5,42 @@
     method:      'PUT'
     body:
       username:  'duffyduck'
+      watchlist:
+      - m333
+      - m79
+      blacklist:
+      - m334
+      - m77
+      skiplist:
+      - m335
+      - m78
+      ratings:
+        m336: 4
+        m79: 2.5
+        m777: 3.0
+        m567: 4.0
+        m354: 5.0
+      expires_at: 2011-09-09T22:41:50+00:00
   response_expectation:
     status_code: 201
     headers:
       Last-Modified:    /.*/
     body:
       username:       'duffyduck'
-      fsk:            "17"
+      watchlist:
+      - m333
+      - m79
+      blacklist:
+      - m334
+      - m77
+      skiplist:
+      - m335
+      - m78
+      ratings:
+        m336: 4.0
+        m79: 2.5
+      fsk:            "18"
+      expires_at: Fri, 09 Sep 2011 22:41:50 +0000
 - name: 'Update existing User - Update watchlist'
   request:
     path:       '/users/duffyduck/watchlist'
@@ -22,4 +51,75 @@
   response_expectation:
     status_code: 204
     body:
-
+- name: 'Check User FSK,Watchlist'
+  request:
+    path:        '/users/duffyduck'
+    method:      'GET'
+  response_expectation:
+    status_code: 200
+    headers:
+      Last-Modified:    /.*/
+    body:
+      username:       'duffyduck'
+      fsk:            "18"
+      watchlist:
+      - m367
+      - m73
+      blacklist:
+      - m334
+      - m77
+      skiplist:
+      - m335
+      - m78
+      ratings:
+        m336: 4.0
+        m79: 2.5
+- name: 'Set 10 Ratings'
+  request:
+    path:        '/users/duffyduck/ratings'
+    method:      'PUT'
+    body:
+      "m1035": 4
+      "m2087": 3
+      "m1554": 2
+      "m2981": 1
+      "m1590": 2
+      "m1056": 3
+      "m12493": 4
+      "m1875": 5
+      "m7258": 2.5
+      "m7339": 3.5
+  response_expectation:
+    status_code: 204
+    headers:
+      Last-Modified:    /.*/
+- name: 'Check User Ratings Update'
+  request:
+    path:        '/users/duffyduck'
+    method:      'GET'
+  response_expectation:
+    status_code: 200
+    headers:
+      Last-Modified:    /.*/
+    body:
+      username:       'duffyduck'
+      fsk:            "18"
+      watchlist:
+      - m367
+      - m73
+      blacklist:
+      - m334
+      - m77
+      skiplist:
+      - m335
+      - m78
+      ratings:
+        "m1035": "1.0"
+        "m2087": "3.0"
+        "m1554": "2.0"
+        "m1590": "2.0"
+        "m1056": "3.0"
+        "m12493": "4.0"
+        "m1875": "5.0"
+        "m7258": "2.5"
+        "m7339": "3.5"

data/lib/api_runner.rb

@@ -10,13 +10,13 @@ class ApiRunner
 
   # initializes the object, loads environment, build base_uri
   def initialize(env)
-    @http_client = HttpClient.new
     @spec = []
     @errors = []
     @excludes = []
     load_config(env)
     load_excludes(env)
     load_url_spec
+    @http_client = HttpClient.new(@host, @port, @namespace)
     @expectation = ExpectationMatcher.new(@excludes)
   end
 
@@ -37,7 +37,7 @@ class ApiRunner
   # runs all testcases that are provided by the testclass an fills errors if there are any
   def run_tests
     @spec.each do |test_case|
-      response = send_request(test_case['request']['method'].downcase.to_sym, target_uri(test_case['request']['path']), {:body => test_case['request']['body'].to_json})
+      response = send_request(test_case['request']['method'].downcase.to_sym, test_case['request']['path'], test_case['request']['body'])
       @expectation.test_types.each do |test_type|
         test = @expectation.check(test_type, response, test_case)
         if not test.succeeded
@@ -57,12 +57,13 @@ class ApiRunner
   end
 
   # builds target uri from base uri generated of host port and namespace as well as the ressource path
-  def target_uri(ressource_path)
-    "#{@protocol}://#{@host}:#{@port}/#{@namespace}" + ressource_path
+  def target_uri
+    "#{@protocol}://#{@host}"
   end
 
   # returns true if server is available
   def server_is_available?
+    return true
     !@http_client.send_request(:get, "#{@protocol}://#{@host}:#{@port}", {:timeout => 5}).nil?
   end
 
@@ -83,7 +84,7 @@ class ApiRunner
   # loads and parses items that need to be excluded from the checks in certain environments
   def load_excludes(env)
     excludes_file = self.class.excludes_file
-    @excludes = YAML.load_file(excludes_file).detect{ |a| a.first == env.to_s }[1]["excludes"]
+    @excludes = YAML.load_file(excludes_file).detect{ |a| a.first == env.to_s }[1]["excludes"] rescue nil
   end
 
   # returns config files path and can be stubbed this way

data/lib/expectation_matcher.rb

@@ -22,7 +22,7 @@ class ExpectationMatcher
   def response_code(response, testcase)
     result_struct = Struct.new(:succeeded, :error)
     results = result_struct.new(:succeeded => true, :error => nil)
-    if not testcase['response_expectation']['status_code'] == response.code
+    if not testcase['response_expectation']['status_code'].to_s == response.code.to_s
       results.succeeded = false
       results.error = "testcase '#{testcase['name']}'\n expected response code --#{testcase['response_expectation']['status_code']}--\n got response code --#{response.code}--"
     end
@@ -64,6 +64,10 @@ class ExpectationMatcher
 
   # matches the given attributes and values against the ones from the response body
   def response_body(response, testcase)
+    puts("Testcase #{testcase['name']}\n")
+    puts("got response --#{response.body}--\n\n")
+    puts("exp response --#{testcase['response_expectation']['body']}--\n")
+    puts("___________________________\n\n\n")
     result_struct = Struct.new(:succeeded, :error)
     results = result_struct.new(:succeeded => true, :error => nil)
 

data/lib/http_client.rb

@@ -1,10 +1,70 @@
 class HttpClient
+  require 'net/http'
+  require 'JSON'
+
+  def initialize(host, port, namespace)
+    @http = Net::HTTP.new(host, port)
+    @host = host
+    @port = port
+    @namespace = namespace
+  end
+
+  def send_request(method, resource, data=nil)
+    build_response(self.send(method.to_s.downcase, resource, data))
+  end
+
+  protected
+
+  # returns struct containing response.code, headers, body and message
+  # this is only for easily interfaceing another http client
+  def build_response(raw_response)
+    response_struct = Struct.new(:code, :message, :headers, :body)
+    response = response_struct.new
+    response.code = raw_response.code
+    response.message = raw_response.message
+    response.body = raw_response.body
+    response.headers = raw_response.header
+    response
+  end
+
+  def get(resource, params)
+    request = Net::HTTP::Get.new(resource_path(resource), initheader = {'Content-Type' =>'application/json'})
+    response = @http.request(request)
+    return response
+  end
+
+  def put(resource, data)
+    request = Net::HTTP::Put.new(resource_path(resource), initheader = {'Content-Type' =>'application/json'})
+    request.body = data.to_json
+    response = @http.request(request)
+  end
+
+  def post(resource, data)
+    request = Net::HTTP::Post.new(resource_path(resource), initheader = {'Content-Type' =>'application/json'})
+    request.body = data.to_json
+    response = @http.request(request)
+  end
+
+
+  def delete(resource, params)
+    request = Net::HTTP::Delete.new(resource_path(resource), initheader = {'Content-Type' =>'application/json'})
+    response = @http.request(request)
+  end
+
+  def resource_path(resource)
+    "/" + @namespace + resource
+  end
+end
+
+
+class HttPartyClient
   require 'httparty'
   include HTTParty
 
   # sends http request with given method, uri and data and returns servers response
   def send_request(method, uri, data=nil)
-    build_response(self.class.send(method, uri, data ||= {}))
+    options = { :body => data.to_json, :format => :json }
+    build_response(self.class.send(method, uri, options))
   end
 
   protected

data/lib/tasks/api.rake

@@ -1,5 +1,7 @@
-config = YAML.load_file("#{Rails.root}/vendor/plugins/telekom_api/config/api_runner.yaml")
-
+begin
+  config = YAML.load_file("#{Rails.root}/config/api_runner.yml")
+rescue
+end
 namespace :api do
   namespace :run do
     config.each_key do |env|
@@ -10,7 +12,7 @@ namespace :api do
         api_runner.run
         puts "\nTestrun finished\n\n"
       end
-    end
+    end unless config.nil?
   end
   desc "generates configuration and a skeleton for apirunner tests as well as excludes"
   task :scaffold do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - jan@moviepilot.com
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-22 00:00:00 +02:00
+date: 2010-09-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,17 +34,17 @@ dependencies:
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: rest-client
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
+        - 1
         - 6
         - 1
-        version: 0.6.1
+        version: 1.6.1
   type: :runtime
   prerelease: false
   version_requirements: *id002
@@ -263,7 +263,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2331822948028323562
+      hash: -4500206872193641389
       segments: 
       - 0
       version: "0"