apirunner 0.1.11 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.2.0

data/apirunner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apirunner}
-  s.version = "0.1.11"
+  s.version = "0.2.0"
 
   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-27}
+  s.date = %q{2010-09-28}
   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 = [
@@ -29,7 +29,13 @@ Gem::Specification.new do |s|
     "changelog.txt",
     "examples/config/api_runner.yml",
     "examples/test/api_runner/001_create_ressource.yml",
+    "examples/test/api_runner/001_create_user.yml",
+    "examples/test/api_runner/002_update_resources.yml",
+    "examples/test/api_runner/003_update_ratings.yml",
+    "examples/test/api_runner/004_pagination.yml",
+    "examples/test/api_runner/005_cache_operations.yml",
     "examples/test/api_runner/999_delete_ressource.yml",
+    "examples/test/api_runner/999_delete_user.yml",
     "examples/test/api_runner/excludes.yml",
     "features/apirunner.feature",
     "features/step_definitions/apirunner_steps.rb",

data/examples/config/api_runner.yml

@@ -19,3 +19,4 @@ general:
     - verbose_on_error
     - verbose_on_success
     - verbose_with_curl
+  priority: 0

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

@@ -0,0 +1,166 @@
+---
+- name: 'Create new User'
+  request:
+    headers:
+      Content-Type: 'application/json'
+    path:        '/users/duffyduck'
+    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'
+      watchlist:
+      - m333
+      - m79
+      blacklist:
+      - m334
+      - m77
+      skiplist:
+      - m335
+      - m78
+      ratings:
+        m336: 4.0
+        m79: 2.5
+      fsk:            "18"
+- name: 'Update existing User - Update watchlist'
+  request:
+    headers:
+      Content-Type: 'application/json'
+    path:       '/users/duffyduck/watchlist'
+    method:     'PUT'
+    body:
+    - m367
+    - m73
+  response_expectation:
+    status_code: 204
+    body:
+- name: 'Check User FSK,Watchlist'
+  request:
+    headers:
+      Content-Type: 'application/json'
+    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:
+    headers:
+      Content-Type: 'application/json'
+    path:        '/users/duffyduck/ratings'
+    method:      'PUT'
+    body:
+      "m1035": 1
+      "m2087": 0.5
+      "m1554": 2
+      "m2981": 1.0
+      "m1590": 2
+      "m12493": 4
+      "m1875": 5
+      "m7258": 2.5
+  response_expectation:
+    status_code: 204
+    headers:
+      Last-Modified:    /.*/
+- name: 'Check User Ratings Update'
+  request:
+    headers:
+      Content-Type: 'application/json'
+    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": "0.5"
+        "m1554": "2.0"
+        "m2981": "1.0"
+        "m1590": "2.0"
+        "m12493": "4.0"
+        "m1875": "5.0"
+        "m7258": "2.5"
+- name: 'User creation should fail on wrong username'
+  priority: 2
+  request:
+    headers:
+      Content-Type: 'application/json'
+    path:        '/users/duffyduck'
+    method:      'PUT'
+    body:
+     username: '!"§$%&/()=?QWERTZUI"§$%&      /('
+  response_expectation:
+    status_code: 409
+- name: 'User creation should fail on wrong fsk'
+  priority: 2
+  request:
+    headers:
+      Content-Type: 'application/json'
+    path:        '/users/duffyduck2'
+    method:      'PUT'
+    body:
+     username: 'duffyduck2'
+     fsk: 2000000
+  response_expectation:
+    status_code: 409
+- name: 'User creation should fail on wrong expiration_date'
+  priority: 2
+  request:
+    headers:
+      Content-Type: 'application/json'
+    path:        '/users/duffyduck3'
+    method:      'PUT'
+    body:
+     username: 'duffyduck3'
+     expires_at: 2009-09-09T22:41:50+00:00
+  response_expectation:
+    status_code: 409

data/examples/test/api_runner/002_update_resources.yml

@@ -0,0 +1 @@
+---

data/examples/test/api_runner/003_update_ratings.yml

@@ -0,0 +1 @@
+---

data/examples/test/api_runner/004_pagination.yml

@@ -0,0 +1 @@
+---

data/examples/test/api_runner/005_cache_operations.yml

@@ -0,0 +1 @@
+---

data/examples/test/api_runner/999_delete_user.yml

@@ -0,0 +1,22 @@
+---
+- name: 'Delete User 1'
+  request:
+    path:        '/users/duffyduck'
+    method:      'DELETE'
+    body:        {}
+  response_expectation:
+    status_code: 202
+- name: 'Delete User 2'
+  request:
+    path:        '/users/duffyduck2'
+    method:      'DELETE'
+    body:        {}
+  response_expectation:
+    status_code: 202
+- name: 'Delete User 3'
+  request:
+    path:        '/users/duffyduck3'
+    method:      'DELETE'
+    body:        {}
+  response_expectation:
+    status_code: 202

data/lib/api_configuration.rb

@@ -1,6 +1,6 @@
 class ApiConfiguration
 
-  attr_accessor :protocol, :host, :namespace, :port, :verbosity
+  attr_accessor :protocol, :host, :namespace, :port, :verbosity, :priority
 
 end
 

data/lib/api_runner.rb

@@ -76,14 +76,48 @@ class ApiRunner
     config = YAML.load_file(self.class.config_file)
     config[env.to_s].each { |key, value| @configuration.instance_variable_set("@#{key}", value) }
     @configuration.verbosity = config['general']['verbosity'].first
+    @configuration.priority = config['general']['priority'] || 0
   end
 
   # loads spec cases from yaml files
   def load_url_spec
     path = self.class.spec_path
+    specs = []
     Dir.new(path).entries.each do |dir_entry|
-      @spec.push *YAML.load_file(path+dir_entry) if not (File.directory? dir_entry or dir_entry.match(/^\./) or dir_entry.match(/excludes/))
+      specs.push *YAML.load_file(path+dir_entry) if not (File.directory? dir_entry or dir_entry.match(/^\./) or dir_entry.match(/excludes/))
     end
+    @spec = priorize(partition(specs))
+  end
+
+  # returns only spec whose priority level is less or equals configures priority level
+  # if no priority level is configured for the api runner, 0 is assumed
+  # if no priority level ist configured for a story, 0 is assumed
+  def priorize(specs)
+    relevant_specs = []
+    specs.each do |spec|
+      relevant_specs << spec if spec['priority'].nil? or spec['priority'].to_i <= @configuration.priority.to_i
+    end
+    relevant_specs
+  end
+
+  # partitions the spec if keywords like 'focus', 'until' or 'from exist'
+  # and returns the relevant subset of specs that have to be tested then
+  def partition(specs)
+    relevant_specs = []
+    specs.each do |spec|
+      if spec['focus']
+        relevant_specs << spec
+        break
+      elsif spec['until']
+        relevant_specs = specs[0..specs.index(spec)]
+        break
+      elsif spec['from']
+        relevant_specs = specs[specs.index(spec)..specs.size+1]
+        break
+      end
+    end
+    relevant_specs = specs if relevant_specs.empty?
+    relevant_specs
   end
 
   # loads and parses items that need to be excluded from the checks in certain environments

data/lib/http_client.rb

@@ -17,12 +17,15 @@ class HttpClient
   # returns struct containing response.code, headers, body and message
   # this is only for easily interfaceing another http client
   def build_response(raw_response)
+    debugger
     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.headers = raw_response.header
+    # TODO improve me!
+    response.headers = JSON.parse(raw_response.header.to_json) rescue nil
     response
   end
 

data/lib/result.rb

@@ -27,9 +27,7 @@ class Result
 
   # yields a more verbose error message only in case of an error
   def verbose_on_error(index)
-    if not @succeeded
-      be_verbose(index)
-    end
+    be_verbose(index) if not @succeeded
   end
 
   # yields a more verbose message in case of an error AND success
@@ -45,22 +43,21 @@ class Result
 
   # yields the verbose error messages
   def be_verbose(index)
-    debugger
-      puts "\n#{result_case} (#{index+1}) - \"#{@testcase['name']}\""
-      puts @error_message
-      puts("  More more more verbosity\n")
-      puts("  request method: #{@testcase['request']['method']}")
-      puts("  resource path: #{@testcase['request']['path']}")
-      puts("  request headers: #{@testcase['request']['headers']}")
-      puts("  JSON body sent: #{@testcase['request']['body']}")
-      puts("  expectation:")
-      puts("    response status code: #{@testcase['response_expectation']['status_code']}")
-      puts("    response headers: #{@testcase['response_expectation']['headers']}")
-      puts("    response body: #{@testcase['response_expectation']['body']}")
-      puts("  result:")
-      puts("    response status code: #{@response.code}")
-      puts("    response headers: #{@response.headers}")
-      puts("    repsonse body: #{JSON.parse(@response.body) rescue nil}")
+    puts "\n#{result_case} (#{index+1}) - \"#{@testcase['name']}\""
+    puts @error_message
+    puts("  More more more verbosity\n")
+    puts("  request method: #{@testcase['request']['method']}")
+    puts("  resource path: #{@testcase['request']['path']}")
+    puts("  request headers: #{@testcase['request']['headers']}")
+    puts("  JSON body sent: #{@testcase['request']['body']}")
+    puts("  expectation:")
+    puts("    response status code: #{@testcase['response_expectation']['status_code']}")
+    puts("    response headers: #{@testcase['response_expectation']['headers']}")
+    puts("    response body: #{@testcase['response_expectation']['body']}")
+    puts("  result:")
+    puts("    response status code: #{@response.code}")
+    puts("    response headers: #{@response.headers}")
+    puts("    response body: #{JSON.parse(@response.body) rescue nil}")
   end
 
   # returns the result case for interpolation in the output message header

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 11
-  version: 0.1.11
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - jan@moviepilot.com
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 +02:00
+date: 2010-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -233,7 +233,13 @@ files:
 - changelog.txt
 - examples/config/api_runner.yml
 - examples/test/api_runner/001_create_ressource.yml
+- examples/test/api_runner/001_create_user.yml
+- examples/test/api_runner/002_update_resources.yml
+- examples/test/api_runner/003_update_ratings.yml
+- examples/test/api_runner/004_pagination.yml
+- examples/test/api_runner/005_cache_operations.yml
 - examples/test/api_runner/999_delete_ressource.yml
+- examples/test/api_runner/999_delete_user.yml
 - examples/test/api_runner/excludes.yml
 - features/apirunner.feature
 - features/step_definitions/apirunner_steps.rb
@@ -265,7 +271,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3573133429557271609
+      hash: -2602692957616549135
       segments: 
       - 0
       version: "0"