rack-test-rest 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 259bc58c5eed3c443e4066daec756cc850d4d56b
+  data.tar.gz: 4339f92a6292a5d48333994d5690b95d63b877ec
+SHA512:
+  metadata.gz: d2fbaaffc53a8693852b7192d8b4ea786add56bb0317ea17e52c9eb9f945de982830bbe211cc18be33af5256b53257d9686ebcd09ce699f695ff3efa0076bc12
+  data.tar.gz: b7494c03b1c68e62dd241493e93019dba081704d5d256436012501972204a7cab9b09ee0de3072bda4cbe1eacc711dae2146cbe6f278d04026acbcc68dc37855

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/rack-test-rest.png)](http://badge.fury.io/rb/rack-test-rest)
+
 `rack-test-rest` is an extension to `rack-test` that when combined with
 `Test::Unit` simplifies the process of unit testing properly
 designed RESTful API's.
@@ -126,5 +128,5 @@ that a single index operation may return (defaults to 100).
 
 # Copyright
 
-Copyright (c) 2011-2013 Joseph Ruscio. See LICENSE.txt for
+Copyright (c) 2011-2014 Joseph Ruscio. See LICENSE.txt for
 further details.

data/lib/rack-test-rest.rb

@@ -4,41 +4,18 @@ module Rack
   module Test
     module Rest
 
+      # defines expected resource-to-uri scheme. overload this in your class
+      # if needed.
+      #
       def resource_uri
         "#{@rack_test_rest[:root_uri]}/#{@rack_test_rest[:resource]}"
       end
 
-      def handle_error_code(code)
-        assert_status_code(code)
-
-        if @rack_test_rest[:debug]
-          puts "Status: #{last_response.status}" if @rack_test_rest[:debug]
-          puts "Headers:"
-          puts last_response.headers.inspect
-          puts "Body: #{last_response.body}" if @rack_test_rest[:debug]
-        end
-        assert_content_type_is_json
-
-        if last_response.headers['Content-Length'].to_i > 0
-          JSON.parse(last_response.body)
-        else
-          nil
-        end
-      end
-
-      # remove library lines from call stack so error is reported
-      # where the call to rack-test-rest is being made
-      def with_clean_backtraces
-        yield
-      rescue MiniTest::Assertion => error
-        cleaned = error.backtrace.reject {|l| l.index(/rack-test-rest[-.0-9]{0,}\/lib/)}
-        error.set_backtrace(cleaned)
-        raise
-      end
-
+      # create a new instance of the given resource, expecting a 201
+      # unless the :code option is specified.
+      #
       def create_resource(params={})
-        expected_code = params[:code]
-        params.delete :code
+        expected_code = params.delete(:code)
 
         puts "Posting to: '#{resource_uri}#{@rack_test_rest[:extension]}'" if @rack_test_rest[:debug]
         post "#{resource_uri}#{@rack_test_rest[:extension]}", params
@@ -66,13 +43,18 @@ module Rack
         last_response.original_headers["Location"]
       end
 
+      # create resource, but expect a 400 - helper for the common case
+      # of testing invalid parameters for creating your resource.
+      #
+      def create_resource_invalid(opts)
+        create_resource({code: 400}.merge(opts))
+      end
+
       def read_resource(params={})
-        expected_code = params[:code]
-        params.delete :code
+        id = params.delete(:id)
+        expected_code = params.delete(:code)
 
-        if params[:id]
-          id = params[:id]
-          params.delete(:id)
+        if id
           uri = "#{resource_uri}/#{id}#{@rack_test_rest[:extension]}"
         else
           uri = "#{resource_uri}#{@rack_test_rest[:extension]}"
@@ -99,11 +81,8 @@ module Rack
       end
 
       def update_resource(params={})
-        expected_code = params[:code]
-        params.delete :code
-
-        id = params[:id]
-        params.delete(:id)
+        id = params.delete(:id)
+        expected_code = params.delete(:code)
 
         puts "Attempting to update #{id} with #{params.inspect}" if @rack_test_rest[:debug]
 
@@ -116,6 +95,13 @@ module Rack
         end
       end
 
+      # update resource, but expect a 400 - helper for the common case
+      # of testing invalid parameters for updating your resource.
+      #
+      def update_resource_invalid(opts)
+        update_resource({code: 400}.merge(opts))
+      end
+
       def delete_resource(params={})
         delete "#{resource_uri}/#{params[:id]}#{@rack_test_rest[:extension]}"
 
@@ -125,22 +111,26 @@ module Rack
         end
       end
 
+      # Create a set number of the resource and test pagination up
+      # to that number.
+      #
       def paginate_resource(opts={})
-
-        count = opts[:count] ? opts[:count] : 512
-        max = opts[:max_length] ? opts[:max_length] : 100
-        existing_resource_count = opts[:existing_resource_count] || 0
+        count       = opts.fetch(:count, 512)
+        do_create   = opts.fetch(:do_create, true)
+        max         = opts.fetch(:max_length, 100)
+        read_params = opts.fetch(:read_params, {})
+        start_count = opts.fetch(:existing_resource_count, 0)
 
         #populate the DB
         0.upto(count - 1) do |id|
-          if opts[:do_create] == false
-            yield(id)
-          else
+          if do_create
             create_resource(yield(id))
+          else
+            yield(id)
           end
         end
 
-        total = count + existing_resource_count
+        total = count + start_count
         retrieved = 0
         offset = 0
 
@@ -155,7 +145,8 @@ module Rack
             puts "Expecting '#{expected_length}'"
           end
 
-          pg_resp = read_resource(:offset => offset, :length => length)
+          get_params = read_params.merge(offset: offset, length: length)
+          pg_resp = read_resource(get_params)
 
           with_clean_backtraces do
             puts "Received #{pg_resp[@rack_test_rest[:resource]].count} records" if @rack_test_rest[:debug]
@@ -187,6 +178,36 @@ module Rack
           "Expected status #{code}, but got a #{last_response.status}.\nBody: #{last_response.body.empty? ? "empty" : last_response.body.inspect.chomp}"
       end
 
+      def handle_error_code(code)
+        assert_status_code(code)
+
+        if @rack_test_rest[:debug]
+          puts "Status: #{last_response.status}"
+          puts "Headers:"
+          puts last_response.headers.inspect
+          puts "Body: #{last_response.body}"
+        end
+        assert_content_type_is_json
+
+        if last_response.headers['Content-Length'].to_i > 0
+          JSON.parse(last_response.body)
+        else
+          nil
+        end
+      end
+
+      # remove library lines from call stack so error is reported
+      # where the call to rack-test-rest is being made
+      def with_clean_backtraces
+        yield
+      rescue MiniTest::Assertion => error
+        cleaned = error.backtrace.reject do |line|
+          line.index(/rack-test-rest[-.0-9]{0,}\/lib/)
+        end
+        error.set_backtrace(cleaned)
+        raise
+      end
+
     end
   end
 end

data/lib/rack-test-rest/version.rb

@@ -1,7 +1,7 @@
 module Rack
   module Test
     module Rest
-      VERSION = '0.6.0'
+      VERSION = '0.7.0'
     end
   end
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rack-test-rest
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
 - Joseph Ruscio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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: Extends rack-test to simplifies the process of unit testing properly
@@ -46,30 +43,26 @@ files:
 homepage: https://github.com/josephruscio/rack-test-rest
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3995603219145648516
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Easy testing of RESTful API's with rack-test and Test::Unit.
 test_files:
 - test/helper.rb