hyperspec 0.0.1 → 0.0.2

data/README.md

@@ -1,5 +1,3 @@
-# This is Work in Progress
-
              __  __                     ______
             / / / /_  _________________/ ____/________________
            / /_/ / / / / __ \  _ \_ __/____ \/ __ \  _ \  ___/
@@ -14,42 +12,44 @@ HTTP APIs from the outside.
 
 ## Example
 
-    service "http://localhost:4567" do
-      def response_json
-        JSON.parse(response.body)
-      end
-
-      resource "/lolz" do
-        get do
-          it { responds_with.status :ok }
-          it { response_json['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|
-                lol['title'].must_match /monorail/
-              end
-            end
+```ruby
+service "http://localhost:4567" do
+  def response_json
+    JSON.parse(response.body)
+  end
+
+  resource "/lolz" do
+    get do
+      it { responds_with.status :ok }
+      it { response_json['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|
+            lol['title'].must_match /monorail/
           end
         end
+      end
+    end
 
-        post do
-          describe "without request body" do
-            it { responds_with.status :unprocessable_entity }
-          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!' }
-              end
-            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!' }
           end
         end
       end
     end
+  end
+end
+```
 
 ## Concepts
 
@@ -99,6 +99,10 @@ Allows for comparing against named status code symbols.
 
 - DSL for matching representations.
 
+### Documentation
+
+- Adding an output format for docs.
+
 ## Concerns
 
 - Efficient ways of building up and verifying precondition state.
@@ -107,12 +111,24 @@ Allows for comparing against named status code symbols.
 
 ## Acknowledgments
 
-Thanks to Daniel Bornkessel for inspiring me to do README driven development.
+Thanks to:
+
+- [Daniel Bornkessel](https://github.com/kesselborn) for inspiring me to do `README` driven development.
+- [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
 
 ## History
 
-### 2012 02 07
+### 0.0.2
+
+#### 2012 03 30
+
+- Correcting environment dependencies.
+- Adding support for HTTP Basic Auth.
+
+### 0.0.1
 
-#### 0.0.1
+#### 2012 02 07
 
 - Initial release

data/examples/service/example.rb

@@ -18,6 +18,6 @@ post "/lolz" do
       %^{"lol": {"title": "Roflcopter!"}}^
     end
   else
-    status 422
+    status 415
   end
 end

data/hyperspec.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency *dependency
   end
 
-  (dependencies + developement_dependencies).each do |dependency|
+  (dependencies + runtime_dependencies).each do |dependency|
     s.add_runtime_dependency *dependency
   end
 end

data/lib/hyperspec.rb

@@ -10,75 +10,71 @@ module HyperSpec
   module ObjectExtensions
     private
     def service(desc, additional_desc = nil, &block)
-      cls = describe(desc, additional_desc, &block)
-      cls.send(:define_method, :base_uri) { URI.parse(desc) }
-      cls.send(:define_method, :headers)  { {} }
-      cls.send(:define_method, :request_body)  { "" }
-      cls
+      describe(desc, additional_desc, &block).tap do |cls|
+        cls.class_eval do
+          define_method(:base_uri)     { URI.parse(desc) }
+          define_method(:headers)      { {} }
+          define_method(:request_body) { "" }
+        end
+      end
     end
 
     def resource(path, additional_desc = nil, &block)
-      cls = describe(desc, additional_desc, &block)
-
-      cls.send(:define_method, :base_uri) do
-        s = super()
-        s.path = [ s.path, path ].reject(&:empty?).join("/")
-        s
+      describe(desc, additional_desc, &block).tap do |cls|
+        cls.class_eval do
+          define_method(:base_uri) do
+            super().tap do |s|
+              s.path = [ s.path, path ].reject(&:empty?).join("/")
+            end
+          end
+        end
       end
-      cls
     end
 
     def with_headers(hash, additional_desc = nil, &block)
-      cls = describe("with headers", additional_desc, &block)
-      cls.send(:define_method, :headers) { super().merge(hash) }
-      cls
+      describe("with headers", additional_desc, &block).tap do |cls|
+        cls.class_eval do
+          define_method(:headers) { super().merge(hash) }
+        end
+      end
     end
 
     def with_query(string, additional_desc = nil, &block)
-      cls = describe("with query", additional_desc, &block)
-      cls.send(:define_method, :base_uri) do
-        s = super()
-        s.query = [ s.query.to_s, string ].reject(&:empty?).join("&")
-        s
+      describe("with query", additional_desc, &block).tap do |cls|
+        cls.class_eval do
+          define_method(:base_uri) do
+            super().tap do |s|
+              s.query = [ s.query.to_s, string ].reject(&:empty?).join("&")
+            end
+          end
+        end
       end
-      cls
     end
 
     def with_request_body(string, additional_desc = nil, &block)
-      cls = describe("with request body", additional_desc, &block)
-      cls.send(:define_method, :request_body) do
-        string
+      describe("with request body", additional_desc, &block).tap do |cls|
+        cls.class_eval do
+          define_method(:request_body) { string }
+        end
       end
-      cls
     end
 
     # HTTP method selection
     #
-    def get(additional_desc = nil, &block)
-      cls = describe('GET', additional_desc, &block)
-      cls.instance_eval { |_| def request_type; :get; end }
-      cls
-    end
-
-    def head(additional_desc = nil, &block)
-      cls = describe('HEAD', additional_desc, &block)
-      cls.instance_eval { |_| def request_type; :head; end }
-      cls
-    end
-    def post(additional_desc = nil, &block)
-      cls = describe('POST', additional_desc, &block)
-      cls.instance_eval { |_| def request_type; :post; end }
-      cls
-    end
-    def put(additional_desc = nil, &block)
-      cls = describe('PUT', additional_desc, &block)
-      cls.instance_eval { |_| def request_type; :put; end }
-      cls
-    end
-    def delete(additional_desc = nil, &block)
-      cls = describe('DELETE', additional_desc, &block)
-      cls.instance_eval { |_| def request_type; :delete; end }
-      cls
+    {
+      'get'    => Net::HTTP::Get,
+      'head'   => Net::HTTP::Head,
+      'post'   => Net::HTTP::Post,
+      'put'    => Net::HTTP::Put,
+      'delete' => Net::HTTP::Delete,
+    }.each do |http_method, request_class|
+      define_method(http_method) do |additional_desc = nil, &block|
+        describe(http_method.upcase, additional_desc, &block).tap do |cls|
+          cls.class_eval do
+            define_method(:request_class) { request_class }
+          end
+        end
+      end
     end
   end
 
@@ -88,19 +84,14 @@ module HyperSpec
         do_request
       end
 
-      def request_type
-        self.class.request_type
-      end
-
       def responds_with
         Have.new(response)
       end
 
       private
       def do_request
-        klass = eval("Net::HTTP::#{request_type.to_s.gsub(/^\w/) { |c| c.upcase }}")
         @do_request ||=
-          request_response(klass, base_uri, headers, request_body)
+          request_response(request_class, base_uri, headers, request_body)
       end
 
       def request_response(klass, uri, headers, body = '')
@@ -117,11 +108,13 @@ module HyperSpec
             req = klass.new(request_uri)
             headers.inject(req) { |m, (k, v)| m[k] = v; m }
             req.body = body if body
+            req.basic_auth(uri.user, uri.password) if uri.userinfo
             if headers['Content-Type']
               req.content_type = headers['Content-Type']
             end
             http.request(req)
           end
+
         Response.from_net_http_response(resp)
       end
     end
@@ -188,6 +181,5 @@ module HyperSpec
   end
 end
 
-
 ::Object.send(:include, HyperSpec::ObjectExtensions)
 ::MiniTest::Spec.send(:include, HyperSpec::MiniTest::SpecExtensions)

data/lib/hyperspec/version.rb

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

data/spec/fixtures/vcr_cassettes/localhost.yml

@@ -92,3 +92,44 @@
     body: |+
       {"is-this-json":true}
 
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://username@localhost:80/secret
+    headers:
+      authorization:
+      - Basic dXNlcm5hbWU6cGFzc3dvcmQ=
+    body:
+  response: !ruby/struct:VCR::Response
+    http_version: "1.1"
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-length:
+      - "24"
+      content-type:
+      - application/json;charset=utf-8
+    body: |+
+      {"is-this-secret":true}
+
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://username:password@localhost:80/secret
+    headers:
+      authorization:
+      - Basic dXNlcm5hbWU6cGFzc3dvcmQ=
+    body:
+  response: !ruby/struct:VCR::Response
+    http_version: "1.1"
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-length:
+      - "24"
+      content-type:
+      - application/json;charset=utf-8
+    body: |+
+      {"is-this-secret":true}

data/spec/hyperspec_spec.rb

@@ -21,8 +21,8 @@ describe HyperSpec do
 
   use_vcr_cassette('localhost')
 
-  it "should be of version 0.0.0" do
-    HyperSpec::VERSION.must_equal "0.0.0"
+  it "should be of version 0.0.1" do
+    HyperSpec::VERSION.must_equal "0.0.1"
   end
 
   describe "MiniTest::Spec extensions" do
@@ -119,7 +119,13 @@ describe HyperSpec do
       it { subject.request_body.must_equal "lol[title]=Roflcopter" }
     end
 
-    %w[ get head post put delete ].map(&:to_sym).each do |http_method|
+    {
+      'get'    => Net::HTTP::Get,
+      'head'   => Net::HTTP::Head,
+      'post'   => Net::HTTP::Post,
+      'put'    => Net::HTTP::Put,
+      'delete' => Net::HTTP::Delete,
+    }.each do |http_method, request_class|
       describe "HTTP method selection" do
         subject do
           the_spec do |bound|
@@ -131,7 +137,7 @@ describe HyperSpec do
           end
         end
 
-        it { subject.request_type.must_equal http_method }
+        it { subject.request_class.must_equal request_class }
       end
     end
 
@@ -198,5 +204,35 @@ describe HyperSpec do
       it { subject.status_code 200 }
       it { subject.status :ok }
     end
+
+    describe "basic auth" do
+      describe "with username" do
+        subject do
+          the_spec do |bound|
+            service("http://username@localhost") do
+              resource("/secret") do
+                bound.value = get {}
+              end
+            end
+          end.response
+        end
+
+        it { subject.status_code.must_equal 200 }
+      end
+
+      describe "with username and password" do
+        subject do
+          the_spec do |bound|
+            service("http://username:password@localhost") do
+              resource("/secret") do
+                bound.value = get {}
+              end
+            end
+          end.response
+        end
+
+        it { subject.status_code.must_equal 200 }
+      end
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: hyperspec
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Hannes Tyd\xC3\xA9n"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-07 00:00:00 Z
+date: 2012-03-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -56,28 +56,6 @@ dependencies:
         version: "2.11"
   type: :runtime
   version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: vcr
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.6"
-  type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: webmock
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
-  version_requirements: *id006
 description: "    By extending minitest/spec HyperSpec provides a Ruby DSL for testing HTTP APIs from the \"outside\".\n"
 email: 
 - hannes@soundcloud.com