apirunner 0.5.0 → 0.5.5

data/examples/config/api_runner.yml

@@ -5,12 +5,12 @@ local:
   namespace: api1v0
 staging:
   protocol: http
-  host: staging.premium.moviepilot.com
+  host: staging.premium.yourhost.com
   port: 80
   namespace: api1v0
 production:
   protocol: http
-  host: vtu.premium.moviepilot.com
+  host: vtu.premium.yourhost.com
   port: 80
   namespace: api1v0
 general:

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

@@ -1,173 +1,260 @@
 ---
-- name: 'Create new Basic User'
+- name: "001/1: Search for non existing user without correct OAuth sig should fail"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffybasic'
-    method:      'PUT'
+      Accept:       'application/json'
+    path:           '/users/0815471169'
+    method:         'GET'
     body:
-      username:  'duffybasic'
-      expires_at: 2011-09-09T22:41:50+00:00
+  response_expectation:
+    status_code:    401
+    headers:
+      Last-Modified:    /.*/
+    body:
+- name: "001/2: Search for non existing user with correct OAuth sig should return a 204"
+  request:
+    headers:
+      Content-Type: 'application/json'
+      Accept:       'application/json'
+    path:           '/users/0815471169'
+    method:         'GET'
+    body:
+    oauth:          true
+  response_expectation:
+    status_code: 204
+    headers:
+      Last-Modified:    /.*/
+    body:
+- name: "001/3: Creating a guest user with POST parameters should succeed with a 201"
+  request:
+    headers:
+      Accept:       'application/json'
+    path:           '/users'
+    method:         'POST'
+    parameters:
+      id:           '08154711'
+    body:
+    oauth:          true
   response_expectation:
     status_code: 201
     headers:
       Last-Modified:    /.*/
     body:
-      username:       'duffybasic'
-- name: 'Create new User'
+- name: "001/4: Creating a guest user with JSON parameters should succeed with a 201"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffyduck'
-    method:      'PUT'
-    body:
-      username:  'duffyduck'
-      watchlist:
-      - m1035
-      - m2087
-      blacklist:
-      - m1554
-      - m2981
-      skiplist:
-      - m1590
-      - m1056
-      ratings:
-        m12493: 4.0
-        m1875: 2.5
-        m7258: 3.0
-        m7339: 4.0
-        m3642: 5.0
-      expires_at: 2011-09-09T22:41:50+00:00
+      Accept:       'application/json'
+    path:           '/users'
+    method:         'POST'
+    body:
+      id:           '08154712'
+    oauth:          true
   response_expectation:
     status_code: 201
     headers:
       Last-Modified:    /.*/
     body:
-      username:       'duffyduck'
-      watchlist:
-      - m1035
-      - m2087
-      blacklist:
-      - m1554
-      - m2981
-      skiplist:
-      - m1590
-      - m1056
-      ratings:
-        m12493: 4.0
-        m1875: 2.5
-        m7258: 3.0
-        m7339: 4.0
-        m3642: 5.0
-      fsk:            "18"
-- name: 'Update existing User - Update watchlist'
+- name: "001/5: Creating a guest user with JSON parameters without OAuth should result in a 401"
   request:
     headers:
       Content-Type: 'application/json'
-    path:       '/users/duffyduck/watchlist'
-    method:     'PUT'
+      Accept:       'application/json'
+    path:           '/users'
+    method:         'POST'
     body:
-    - m367
-    - m73
+      id:           '08154713'
   response_expectation:
-    status_code: 204
+    status_code: 401
+    headers:
+      Last-Modified:    /.*/
     body:
-- name: 'Check User FSK,Watchlist'
+- name: "001/6: Search for previously created user with correct OAuth sig should return the user"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffyduck'
-    method:      'GET'
+      Accept:       'application/json'
+    path:           '/users/08154712'
+    method:         'GET'
+    body:
+    oauth:          true
   response_expectation:
     status_code: 200
     headers:
       Last-Modified:    /.*/
     body:
-      username:       'duffyduck'
-      fsk:            "18"
-      watchlist:
-      - m367
-      - m73
-      blacklist:
-      - m1554
-      - m2981
-      skiplist:
-      - m1590
-      - m1056
-      ratings:
-        m12493: 4.0
-        m1875: 2.5
-        m7258: 3.0
-        m7339: 4.0
-        m3642: 5.0
-- name: 'Set 10 Ratings'
+      version:      'v5'
+      content:
+        user:
+          vz_id:    '08154712'
+          username: /^Guest_.*$/
+          guest:    true
+- name: "001/7: Recreating a guest user with POST parameters should fail in case the user already exists"
+  request:
+    headers:
+      Accept:       'application/json'
+    path:           '/users'
+    method:         'POST'
+    parameters:
+      id:           '08154712'
+    body:
+    oauth:          true
+  response_expectation:
+    status_code: 422
+    headers:
+      Last-Modified:    /.*/
+    body:
+- name: "001/8: Recreating a guest user with JSON parameters should fail in case the user already exists"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffyduck/ratings'
-    method:      'PUT'
+      Accept:       'application/json'
+    path:           '/users'
+    method:         'POST'
     body:
-      "m1035": 1
-      "m1554": 2
-      "m2981": 1.0
-      "m1590": 2
-      "m12493": 4
-      "m1875": 5
-      "m7258": 2.5
+      id:           '08154712'
+    oauth:          true
   response_expectation:
-    status_code: 204
+    status_code: 422
     headers:
       Last-Modified:    /.*/
-- name: 'Check User Ratings Update'
+    body:
+- name: "001/9: Updating a guest user via PUT parameters should succeed"
+  priority:         5
+  request:
+    headers:
+      Accept:       'application/json'
+    path:           '/users/08154712'
+    method:         'PUT'
+    parameters:
+      access_token: 'vz_t0k3n'
+    body:
+    oauth:          true
+  response_expectation:
+    status_code: 201
+    headers:
+      Last-Modified:    /.*/
+    body:
+      version:      'v5'
+      content:
+        user:
+          vz_id:    '08154712'
+          username: /^Guest_.*$/
+          guest:    true
+- name: "001/10: Updating a guest user via JSON should succeed"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffyduck'
-    method:      'GET'
+      Accept:       'application/json'
+    path:           '/users/08154712'
+    method:         'PUT'
+    body:
+      id:           '08154712'
+      access_token: 'vz_t0k3n'
+    oauth:          true
   response_expectation:
-    status_code: 200
+    status_code: 201
+    headers:
+      Last-Modified:    /.*/
+    body:
+      version:      'v5'
+      content:
+        user:
+          vz_id:    '08154712'
+          username: /^Guest_.*$/
+          guest:    true
+- name: "001/11: Updating a guest user via PUT parameters without valid OAuth sig should fail"
+  request:
+    headers:
+      Accept:       'application/json'
+    path:           '/users/08154712'
+    method:         'PUT'
+    parameters:
+      id:           '08154712'
+      access_token: 'vz_t0k3n'
+    body:
+  response_expectation:
+    status_code: 401
     headers:
       Last-Modified:    /.*/
     body:
-      username:       'duffyduck'
-      fsk:            "18"
-      ratings:
-        "m1035": "1.0"
-        "m1554": "2.0"
-        "m2981": "1.0"
-        "m1590": "2.0"
-        "m12493": "4.0"
-        "m1875": "5.0"
-        "m7258": "2.5"
-- name: 'User creation should fail on bogus characters in username'
-  priority: 3
+- name: "001/12: Updating a guest user via JSON without valid OAuth sig should fail"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffyduck_fix_me'
-    method:      'PUT'
+      Accept:       'application/json'
+    path:           '/users/08154712'
+    method:         'PUT'
     body:
+      id:           '08154712'
+      access_token: 'vz_t0k3n'
   response_expectation:
-    status_code: 409
-- name: 'User creation should fail on wrong fsk'
+    status_code: 401
+    headers:
+      Last-Modified:    /.*/
+    body:
+- name: "001/13: Updating a guest user via PUT parameters with invalid parameters should fail"
+  request:
+    headers:
+      Accept:       'application/json'
+    path:           '/users/08154712'
+    method:         'PUT'
+    parameters:
+      user:
+        username:   'duffyduck'
+    body:
+    oauth:          true
+  response_expectation:
+    status_code: 422
+    headers:
+      Last-Modified:    /.*/
+    body:
+- name: "001/14: Updating a guest user via JSON without valid OAuth sig should fail"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffyduck2'
-    method:      'PUT'
+      Accept:       'application/json'
+    path:           '/users/08154712'
+    method:         'PUT'
     body:
-     username: 'duffyduck2'
-     fsk: 2000000
+      user:
+        username:   'duffyduck'
+    oauth:          true
   response_expectation:
-    status_code: 409
-- name: 'User creation should fail on wrong expiration_date'
+    status_code: 422
+    headers:
+      Last-Modified:    /.*/
+    body:
+- name: "001/15: Updating a guest user via PUT parameters with invalid user_id should fail with 404"
+  request:
+    headers:
+      Accept:       'application/json'
+    path:           '/users/08154799'
+    method:         'PUT'
+    parameters:
+      user:
+        username:   'duffyduck'
+    body:
+    oauth:          true
+  response_expectation:
+    status_code: 404
+    headers:
+      Last-Modified:    /.*/
+    body:
+- name: "001/16: Updating a guest user via JSON with invalid user_id should fail with 404"
   request:
     headers:
       Content-Type: 'application/json'
-    path:        '/users/duffyduck3'
-    method:      'PUT'
+      Accept:       'application/json'
+    path:           '/users/08154799'
+    method:         'PUT'
     body:
-     username: 'duffyduck3'
-     expires_at: 2009-09-09T22:41:50+00:00
+      user:
+        username:   'duffyduck'
+    oauth:          true
   response_expectation:
-    status_code: 409
+    status_code: 404
+    headers:
+      Last-Modified:    /.*/
+    body:

data/lib/api_runner.rb

@@ -1,6 +1,6 @@
 class ApiRunner
   require 'yaml'
-  require 'csv_writer'
+  require 'csv_writer' if defined?(Rails) and Rails.version.match(/^3.+$/)
   require 'string_ext' if not String.respond_to?(:underscore)
   require 'expectation_matcher'
   require 'http_client'
@@ -24,14 +24,14 @@ class ApiRunner
     load_url_spec
     @http_client = HttpClient.new(@configuration.protocol, @configuration.host, @configuration.port, @configuration.namespace)
     @expectation = ExpectationMatcher.new(@excludes)
-    @csv_writer = CsvWriter.new(self.class.csv_path, env)
+    @csv_writer = CsvWriter.new(self.class.csv_path, env) if defined?(Rails) and Rails.version.match(/^3.+$/)
   end
 
   # checks servers availability and invokes test cases
   def run
     if server_is_available?
       run_tests
-      @csv_writer.write(@configuration.csv_mode, @results) unless @results.empty?
+      @csv_writer.write(@configuration.csv_mode, @results) unless @results.empty? if defined?(Rails) and Rails.version.match(/^3.+$/)
       @results.each_with_index do |result, index|
         result.honk_in(@configuration.verbosity, index)
       end unless @results.empty?

data/lib/apirunner/railtie.rb

@@ -1,11 +1,12 @@
 require 'apirunner'
-require 'rails'
+require 'rails' if defined?(Rails) and Rails.version.match(/^3.+/)
 
 module Apirunner
-  class Railtie < Rails::Railtie
-
-    rake_tasks do
-      load "tasks/api.rake"
+  if defined?(Rails) and Rails.version.match(/^3.+/)
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "tasks/api.rake"
+      end
     end
   end
 end

data/lib/result.rb

@@ -10,7 +10,8 @@ class Result
   end
 
   # honk out the errors message corresponding to the verbosity configuration the user took
-  def honk_in(verbosity="rspec", index)
+  def honk_in(verbosity, index)
+    verbosity ||= "rspec"
     self.send(verbosity.to_sym, index)
   end
 

data/lib/tasks/api.rake

@@ -1,7 +1,14 @@
+if defined?(Rails) and Rails.version.match(/^2.+$/)
+  APIRUNNER_ROOT = File.dirname(__FILE__).to_s + "/../../"
+  TEST_EXAMPLES_PATH = APIRUNNER_ROOT + "examples/test/api_runner"
+  CONFIG_EXAMPLE_PATH = APIRUNNER_ROOT + "examples/config"
+end
+
 begin
   config = YAML.load_file("#{Rails.root}/config/api_runner.yml")
 rescue
 end
+
 namespace :api do
   namespace :run do
     config.delete_if{ |key| key == "general" }.each_key do |env|