hyperspec 0.0.3 → 0.0.4

data/README.md

@@ -14,37 +14,60 @@ HTTP APIs from the outside.
 
 ## Example
 
-```ruby
+```ruby #source: examples/readme/service_spec.rb
 service "http://localhost:4567" do
-  def response_json
+  def responds_with_json_where
     JSON.parse(response.body)
   end
 
   resource "/lolz" do
     get do
+
       it { responds_with.status :ok }
-      it { response_json['lolz'].must_be_instance_of Array }
+
+      it { responds_with_json_where['lolz'].must_be_instance_of Array }
 
       with_query("q=monorail") do
+
         it "only lists lolz that match the query" do
-          response_json['lolz'].wont_be_empty
-          response_json['lolz'].each do |lol|
+          responds_with_json_where['lolz'].wont_be_empty
+          responds_with_json_where['lolz'].each do |lol|
             lol['title'].must_match /monorail/
           end
         end
+
+      end
+
+      with_query("q=looong") do
+
+        it "only lists lolz that match the query" do
+          responds_with_json_where['lolz'].wont_be_empty
+          responds_with_json_where['lolz'].each do |lol|
+            lol['title'].must_match /looong/
+          end
+        end
+
       end
     end
 
     post do
       describe "without request body" do
+
         it { responds_with.status :unprocessable_entity }
+
       end
 
       describe "with request body" do
         with_headers({ 'Content-Type' => 'application/json' }) do
           with_request_body({ "title" => "Roflcopter!" }.to_json) do
+
             it { responds_with.status :created }
-            it { response_json['lol']['title'].must_equal 'Roflcopter!' }
+
+            it do
+              responds_with_json_where['lol']['title'].
+                must_equal 'Roflcopter!'
+            end
+
           end
         end
       end
@@ -67,17 +90,17 @@ Sets the `URI` under test. Absolute or relative to the current scope.
 
 Selects the HTTP method for the request.
 
-### `with_query_string`
+### `with_query`
 
-Sets the query parameters used for a request. Merges with previously set parameters.
+Sets the query component of a request. Overrides previously set parameters.
 
 ### `with_headers`
 
-Sets the headers used for a request. Merges with previously set headers.
+Sets the headers of a request. Merges with previously set headers.
 
 ### `with_body`
 
-Sets the body used for a request. Overrides previously set parameters.
+Sets the body of a request. Overrides previously set parameters.
 
 ### `response`
 
@@ -119,9 +142,22 @@ Thanks to:
 - [Matthias Georgi](https://github.com/georgi) for suggestions for code improvements.
 - [Lars Gierth](https://github.com/lgierth) for updating the example server to respond with 415 Unsupported Media Type in the appropriate case.
 - [Anton Lindqvist](https://github.com/mptre) for adding HTTP Basic Auth
+- [Josh Devins](https://github.com/joshdevins) for noticing missing HTTP status codes and `with_query` documentation inconsistency.
 
 ## History
 
+### 0.0.4
+
+#### 2012 11 22
+
+- Change behavior of `with_query` to override instead of append.
+
+### 0.0.3
+
+#### 2012 08 10
+
+- Add complete list of HTTP response codes.
+
 ### 0.0.2
 
 #### 2012 03 30

data/examples/readme/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'sinatra'

data/examples/readme/service.rb

@@ -0,0 +1,29 @@
+require 'sinatra'
+require 'json'
+
+get "/lolz" do
+  title = params[:q]
+  %^{"lolz": [ { "title": "#{title}" } ]}^
+end
+
+post "/lolz" do
+  request_body = request.env['rack.input'].read
+
+  if request_body == ''
+    status 422
+  else
+    if request.env['CONTENT_TYPE'] == "application/json"
+      params = JSON.parse(request_body)
+
+      if params.nil? || params.empty?
+        status 422
+        %^{"error": "An error occurred!"}^
+      else
+        status 201
+        %^{"lol": {"title": "Roflcopter!"}}^
+      end
+    else
+      status 415
+    end
+  end
+end

data/examples/{service/example.ru → readme/service.ru}

@@ -1,5 +1,5 @@
 require 'rubygems'
 
-require './example'
+require './service'
 
 run Sinatra::Application

data/examples/{spec/example_spec.rb → readme/service_spec.rb}

@@ -3,47 +3,66 @@ require 'minitest/autorun'
 
 require 'json'
 
-# Run `shotgun -p 4567 example.ru` from `examples/service/`.
+# Shell 1:
+# `cd examples/readme`
+# Start service: `rackup -p 4567 example.ru`.
+#
+# Shell 2:
+# Run specs: `be ruby -rubygems examples/readme/service_spec.rb`.
 
 service "http://localhost:4567" do
-  def response_json
+  def responds_with_json_where
     JSON.parse(response.body)
   end
 
   resource "/lolz" do
     get do
+
       it { responds_with.status :ok }
-      it { response_json['lolz'].must_be_instance_of Array }
+
+      it { responds_with_json_where['lolz'].must_be_instance_of Array }
 
       with_query("q=monorail") do
+
         it "only lists lolz that match the query" do
-          response_json['lolz'].wont_be_empty
-          response_json['lolz'].each do |lol|
+          responds_with_json_where['lolz'].wont_be_empty
+          responds_with_json_where['lolz'].each do |lol|
             lol['title'].must_match /monorail/
           end
         end
+
       end
 
       with_query("q=looong") do
+
         it "only lists lolz that match the query" do
-          response_json['lolz'].wont_be_empty
-          response_json['lolz'].each do |lol|
+          responds_with_json_where['lolz'].wont_be_empty
+          responds_with_json_where['lolz'].each do |lol|
             lol['title'].must_match /looong/
           end
         end
+
       end
     end
 
     post do
       describe "without request body" do
+
         it { responds_with.status :unprocessable_entity }
+
       end
 
       describe "with request body" do
         with_headers({ 'Content-Type' => 'application/json' }) do
           with_request_body({ "title" => "Roflcopter!" }.to_json) do
+
             it { responds_with.status :created }
-            it { response_json['lol']['title'].must_equal 'Roflcopter!' }
+
+            it do
+              responds_with_json_where['lol']['title'].
+                must_equal 'Roflcopter!'
+            end
+
           end
         end
       end

data/lib/hyperspec.rb

@@ -44,7 +44,7 @@ module HyperSpec
         cls.class_eval do
           define_method(:base_uri) do
             super().tap do |s|
-              s.query = [ s.query.to_s, string ].reject(&:empty?).join("&")
+              s.query = string
             end
           end
         end

data/lib/hyperspec/version.rb

@@ -1,6 +1,6 @@
 module HyperSpec
   MAJOR   = 0
   MINOR   = 0
-  PATCH   = 3
+  PATCH   = 4
   VERSION = [ MAJOR, MINOR, PATCH ].join(".")
 end

data/spec/hyperspec_spec.rb

@@ -23,8 +23,8 @@ describe HyperSpec do
 
   use_vcr_cassette('localhost')
 
-  it "should be of version 0.0.2" do
-    HyperSpec::VERSION.must_equal "0.0.2"
+  it "should be of version 0.0.4" do
+    HyperSpec::VERSION.must_equal "0.0.4"
   end
 
   describe "MiniTest::Spec extensions" do
@@ -106,6 +106,24 @@ describe HyperSpec do
       it { subject.base_uri.query.must_equal "q=monorail" }
     end
 
+    describe "nested with_query" do
+      subject do
+        the_spec do |bound|
+          service("http://localhost") do
+            resource("/lolz") do
+              with_query("q=monorail") do
+                bound.value = with_query("q=lolz") {}
+              end
+            end
+          end
+        end
+      end
+
+      it 'should override previously set query values' do
+        subject.base_uri.query.must_equal "q=lolz"
+      end
+    end
+
     describe "with_request_body" do
       subject do
         the_spec do |bound|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperspec
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -88,9 +88,10 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- examples/service/example.rb
-- examples/service/example.ru
-- examples/spec/example_spec.rb
+- examples/readme/Gemfile
+- examples/readme/service.rb
+- examples/readme/service.ru
+- examples/readme/service_spec.rb
 - hyperspec.gemspec
 - lib/hyperspec.rb
 - lib/hyperspec/version.rb

data/examples/service/example.rb

@@ -1,23 +0,0 @@
-require 'sinatra'
-require 'json'
-
-get "/lolz" do
-  title = params[:q]
-  %^{"lolz": [ { "title": "#{title}" } ]}^
-end
-
-post "/lolz" do
-  if request.env['CONTENT_TYPE'] == "application/json"
-    params = JSON.parse(request.env['rack.input'].read)
-
-    if params.nil? || params.empty?
-      status 422
-      %^{"error": "An error occurred!"}^
-    else
-      status 201
-      %^{"lol": {"title": "Roflcopter!"}}^
-    end
-  else
-    status 415
-  end
-end