cfoundry 0.4.18 → 0.4.19

data/lib/cfoundry/baseclient.rb

@@ -1,3 +1,4 @@
+require "cfoundry/trace_helpers"
 require "net/https"
 require "net/http/post/multipart"
 require "multi_json"
@@ -6,6 +7,8 @@ require "base64"
 
 module CFoundry
   class BaseClient # :nodoc:
+    include CFoundry::TraceHelpers
+
     LOG_LENGTH = 10
 
     attr_reader :target
@@ -140,7 +143,7 @@ module CFoundry
             Net::HTTP::Get,
             original_options)
         else
-          handle_response(response, accept)
+          handle_response(response, accept, request)
         end
       end
     rescue ::Timeout::Error => e
@@ -277,26 +280,11 @@ module CFoundry
 
     def print_request(request)
       $stderr.puts ">>>"
-      $stderr.puts "REQUEST: #{request.method} #{request.path}"
-      $stderr.puts "REQUEST_HEADERS:"
-      request.each_header do |key, value|
-        $stderr.puts "  #{key} : #{value}"
-      end
-      $stderr.puts "REQUEST_BODY: #{request.body}" if request.body
+      $stderr.puts request_trace(request)
     end
 
     def print_response(response)
-      $stderr.puts "RESPONSE: [#{response.code}]"
-      $stderr.puts "RESPONSE_HEADERS:"
-      response.each_header do |key, value|
-        $stderr.puts "  #{key} : #{value}"
-      end
-      begin
-        parsed_body = MultiJson.load(response.body)
-        $stderr.puts MultiJson.dump(parsed_body, :pretty => true)
-      rescue
-        $stderr.puts "#{response.body}"
-      end
+      $stderr.puts response_trace(response)
       $stderr.puts "<<<"
     end
 
@@ -320,29 +308,19 @@ module CFoundry
       $stderr.puts "... (trimmed)" unless trimmed_locs == interesting_locs
     end
 
-    def handle_response(response, accept)
+    def handle_response(response, accept, request)
       case response
-      when Net::HTTPSuccess, Net::HTTPRedirection
-        if accept == :json
-          if response.is_a?(Net::HTTPNoContent)
-            raise CFoundry::BadResponse.new(
-              204,
-              "Expected JSON response, got 204 No Content")
-          end
-
-          parse_json(response.body)
-        else
-          response.body
-        end
+        when Net::HTTPSuccess, Net::HTTPRedirection
+          accept == :json ? parse_json(response.body) : response.body
 
-      when Net::HTTPNotFound
-        raise CFoundry::NotFound.new(response.code, response.body)
+        when Net::HTTPNotFound
+          raise CFoundry::NotFound.new(request, response)
 
-      when Net::HTTPForbidden
-        raise CFoundry::Denied.new(response.code, response.body)
+        when Net::HTTPForbidden
+          raise CFoundry::Denied.new(request, response)
 
-      else
-        raise CFoundry::BadResponse.new(response.code, response.body)
+        else
+          raise CFoundry::BadResponse.new(request, response)
       end
     end
 

data/lib/cfoundry/errors.rb

@@ -1,3 +1,6 @@
+require "net/https"
+require "multi_json"
+
 module CFoundry
   # Base class for CFoundry errors (not from the server).
   class Error < RuntimeError; end
@@ -47,28 +50,51 @@ module CFoundry
 
   # Exception representing errors returned by the API.
   class APIError < RuntimeError
+    include TraceHelpers
+
     class << self
       def error_classes
         @error_classes ||= {}
       end
     end
 
-    attr_reader :error_code, :description
+    attr_reader :error_code, :description, :request, :response
 
-    # Create an APIError with a given error code and description.
-    def initialize(error_code = nil, description = nil)
-      @error_code = error_code
-      @description = description
+    # Create an APIError with a given request and response.
+    def initialize(request, response, description = nil, error_code = nil)
+      @response = response
+      @request = request
+      @error_code = error_code || response.code
+      @description = description || parse_description
     end
 
     # Exception message.
     def to_s
-      if error_code
-        "#{error_code}: #{description}"
-      elsif description
-        description
+      "#{error_code}: #{description}"
+    end
+
+    def request_trace
+      super(request)
+    end
+
+    def response_trace
+      super(response)
+    end
+
+    private
+    def parse_description
+      begin
+       parse_json(response.body)[:description]
+      rescue MultiJson::DecodeError
+        response.body
+      end
+    end
+
+    def parse_json(x)
+      if x.empty?
+        raise MultiJson::DecodeError.new("Empty JSON string", [], "")
       else
-        super
+        MultiJson.load(x, :symbolize_keys => true)
       end
     end
   end

data/lib/cfoundry/trace_helpers.rb

@@ -0,0 +1,40 @@
+require "net/https"
+require "multi_json"
+
+module CFoundry
+  module TraceHelpers
+
+    def request_trace(request)
+      return nil unless request
+      info = ["REQUEST: #{request.method} #{request.path}"]
+      info << "REQUEST_HEADERS:"
+      info << header_trace(request)
+      info << "REQUEST_BODY: #{request.body}" if request.body
+      info.join("\n")
+    end
+
+
+    def response_trace(response)
+      return nil unless response
+      info = ["RESPONSE: [#{response.code}]"]
+      info << "RESPONSE_HEADERS:"
+      info << header_trace(response)
+      info << "RESPONSE_BODY:"
+      begin
+        parsed_body = MultiJson.load(response.body)
+        info << MultiJson.dump(parsed_body, :pretty => true)
+      rescue
+        info << "#{response.body}"
+      end
+      info.join("\n")
+    end
+
+    private
+
+    def header_trace(headers)
+      headers.to_hash.sort.map do |key, value|
+        "  #{key} : #{value.join(", ")}"
+      end
+    end
+  end
+end

data/lib/cfoundry/uaaclient.rb

@@ -32,15 +32,13 @@ module CFoundry
           :accept => :json,
           :params => query)
 
-      case auth
-      when Net::HTTPRedirection
+      if auth.is_a? Net::HTTPRedirection
         extract_token(auth["location"])
       else
         json = parse_json(auth.body)
-        raise CFoundry::Denied.new(
-          auth.code.to_i,
-          json[:error_description])
+        raise CFoundry::Denied.new(nil, nil, json[:error_description], auth.code)
       end
+
     end
 
     def users
@@ -72,34 +70,23 @@ module CFoundry
 
     private
 
-    def handle_response(response, accept)
+    def handle_response(response, accept, request)
       case response
       when Net::HTTPSuccess, Net::HTTPRedirection
-        if accept == :json
-          if response.is_a?(Net::HTTPNoContent)
-            raise CFoundry::BadResponse.new(
-              204,
-              "Expected JSON response, got 204 No Content")
-          end
-
-          parse_json(response.body)
-        else
-          response.body
-        end
-
+        accept == :json ? parse_json(response.body) : response.body
       when Net::HTTPBadRequest, Net::HTTPUnauthorized, Net::HTTPForbidden
         info = parse_json(response.body)
-        raise Denied.new(response.code, info[:error_description])
+        raise Denied.new(request, response, info[:error_description])
 
       when Net::HTTPNotFound
-        raise NotFound
+        raise CFoundry::NotFound.new(request, response)
 
       when Net::HTTPConflict
         info = parse_json(response.body)
-        raise CFoundry::Denied.new(response.code, info[:message])
+        raise CFoundry::Denied.new(request, response, info[:message])
 
       else
-        raise BadResponse.new(response.code, response.body)
+        raise BadResponse.new(request, response)
       end
     end
 

data/lib/cfoundry/v1/base.rb

@@ -101,38 +101,18 @@ module CFoundry::V1
 
     private
 
-    def handle_response(response, accept)
-      case response
-      when Net::HTTPSuccess, Net::HTTPRedirection
-        if accept == :json
-          if response.is_a?(Net::HTTPNoContent)
-            raise CFoundry::BadResponse.new(
-              204,
-              "Expected JSON response, got 204 No Content")
-          end
-
-          parse_json(response.body)
-        else
-          response.body
-        end
-
-      when Net::HTTPBadRequest, Net::HTTPForbidden, Net::HTTPNotFound,
-            Net::HTTPInternalServerError, Net::HTTPNotImplemented,
-            Net::HTTPBadGateway
-        begin
-          info = parse_json(response.body)
-          return super unless info[:code]
-
-          cls = CFoundry::APIError.error_classes[info[:code]]
-
-          raise (cls || CFoundry::APIError).new(info[:code], info[:description])
-        rescue MultiJson::DecodeError
-          super
-        end
-
-      else
-        super
-      end
+    def handle_response(response, accept, request)
+      # this is a copy paste of v2
+      return super if response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPRedirection)
+
+      info = parse_json(response.body)
+      return super unless info[:code]
+
+      cls = CFoundry::APIError.error_classes[info[:code]]
+
+      raise (cls || CFoundry::APIError).new(request, response, info[:description],  info[:code])
+    rescue MultiJson::DecodeError
+      super
     end
   end
 end

data/lib/cfoundry/v2/base.rb

@@ -118,41 +118,18 @@ module CFoundry::V2
 
     private
 
-    def handle_response(response, accept)
-      case response
-      when Net::HTTPSuccess, Net::HTTPRedirection
-        if accept == :headers
-          return sane_headers(response)
-        end
-
-        if accept == :json
-          if response.is_a?(Net::HTTPNoContent)
-            raise CFoundry::BadResponse.new(
-              204,
-              "Expected JSON response, got 204 No Content")
-          end
-
-          parse_json(response.body)
-        else
-          response.body
-        end
+    def handle_response(response, accept, request)
+      # this is a copy paste of v1
+      return super if response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPRedirection)
 
-      when Net::HTTPBadRequest, Net::HTTPUnauthorized, Net::HTTPNotFound,
-            Net::HTTPNotImplemented, Net::HTTPServiceUnavailable
-        begin
-          info = parse_json(response.body)
-          return super unless info[:code]
+      info = parse_json(response.body)
+      return super unless info[:code]
 
-          cls = CFoundry::APIError.error_classes[info[:code]]
+      cls = CFoundry::APIError.error_classes[info[:code]]
 
-          raise (cls || CFoundry::APIError).new(info[:code], info[:description])
-        rescue MultiJson::DecodeError
-          super
-        end
-
-      else
-        super
-      end
+      raise (cls || CFoundry::APIError).new(request, response, info[:description],  info[:code])
+    rescue MultiJson::DecodeError
+      super
     end
 
     def log_line(io, data)

data/lib/cfoundry/v2/model_magic.rb

@@ -145,6 +145,8 @@ module CFoundry::V2
             json)
         end
       end
+
+      has_summary
     end
 
     def attribute(name, type, opts = {})

data/lib/cfoundry/v2/organization.rb

@@ -12,7 +12,5 @@ module CFoundry::V2
 
     queryable_by :name, :space_guid, :user_guid, :manager_guid,
       :billing_manager_guid, :auditor_guid
-
-    has_summary
   end
 end

data/lib/cfoundry/v2/space.rb

@@ -14,7 +14,5 @@ module CFoundry::V2
     scoped_to_organization
 
     queryable_by :name, :organization_guid, :developer_guid, :app_guid
-
-    has_summary
   end
 end

data/lib/cfoundry/version.rb

@@ -1,4 +1,4 @@
 module CFoundry # :nodoc:
   # CFoundry library version number.
-  VERSION = "0.4.18".freeze
+  VERSION = "0.4.19".freeze
 end

data/spec/cfoundry/baseclient_spec.rb

@@ -13,5 +13,40 @@ describe CFoundry::BaseClient do
         expect { subject }.to raise_error CFoundry::Timeout, "GET https://api.cloudfoundry.com/foo timed out"
       end
     end
+
+    context 'when an HTTPNotFound error occurs' do
+      before {
+
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => 404,
+        :body => "NOT FOUND"
+      }
+
+      it 'raises the correct error' do
+        expect {subject}.to raise_error CFoundry::NotFound, "404: NOT FOUND"
+      end
+    end
+
+
+    context 'when an HTTPForbidden error occurs' do
+      before {
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => 403,
+          :body => "NONE SHALL PASS"
+      }
+
+      it 'raises the correct error' do
+        expect {subject}.to raise_error CFoundry::Denied, "403: NONE SHALL PASS"
+      end
+    end
+
+    context "when any other type of error occurs" do
+      before {
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => 411,
+          :body => "NOT LONG ENOUGH"
+      }
+
+      it 'raises the correct error' do
+        expect {subject}.to raise_error CFoundry::BadResponse, "411: NOT LONG ENOUGH"
+      end
+    end
   end
 end

data/spec/cfoundry/errors_spec.rb

@@ -11,4 +11,65 @@ describe 'Errors' do
     its(:uri) { should eq '/blah' }
     its(:parent) { should eq parent }
   end
+
+  describe CFoundry::APIError do
+    let(:request) { Net::HTTP::Get.new("http://api.cloudfoundry.com/foo") }
+    let(:response) { Net::HTTPNotFound.new("foo", 404, "bar")}
+    let(:response_body) { "NOT FOUND" }
+    subject { CFoundry::APIError.new(request, response) }
+
+    before do
+      stub(response).body {response_body}
+    end
+
+    its(:to_s) { should eq "404: NOT FOUND" }
+
+    its(:request) { should eq request }
+
+    its(:response) { should eq response }
+
+    describe "#initialize" do
+
+      context "Response body is JSON" do
+
+        let(:response_body) { "{\"description\":\"Something went wrong\"}"}
+
+        it "sets description to description field in parsed JSON" do
+          CFoundry::APIError.new(request, response).description.should == "Something went wrong"
+        end
+      end
+
+
+      context "Response body is not JSON" do
+
+        let(:response_body) { "Some plain text"}
+
+        it "sets description to body text" do
+          CFoundry::APIError.new(request, response).description.should == "Some plain text"
+        end
+      end
+
+      it "allows override of description" do
+        CFoundry::APIError.new(request, response, "My description").description.should == "My description"
+      end
+
+    end
+
+    describe "#request_trace" do
+      its(:request_trace) { should include "REQUEST: " }
+    end
+
+    describe "#response_trace" do
+      its(:response_trace) { should include "RESPONSE: " }
+    end
+
+    it "sets error code to response error code by default" do
+      CFoundry::APIError.new(request, response).error_code.should == 404
+    end
+
+    it "allows override of error code" do
+      CFoundry::APIError.new(request, response, nil, 303).error_code.should == 303
+    end
+
+  end
 end

data/spec/cfoundry/trace_helpers_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe CFoundry::TraceHelpers do
+  let(:fake_class) { Class.new { include CFoundry::TraceHelpers } }
+  let(:request) { Net::HTTP::Get.new("http://api.cloudfoundry.com/foo", "bb-FOO" => "bar") }
+  let(:response) { Net::HTTPNotFound.new("foo", 404, "bar") }
+
+  shared_examples "request_trace tests" do
+    it { should include request_trace }
+    it { should include header_trace }
+    it { should include body_trace }
+  end
+
+  shared_examples "response_trace tests" do
+    before { stub(response).body { response_body } }
+
+    it "traces the provided response" do
+      fake_class.new.response_trace(response).should == response_trace
+    end
+  end
+
+  describe "#request_trace" do
+    let(:request_trace) { "REQUEST: GET http://api.cloudfoundry.com/foo" }
+    let(:header_trace) { "REQUEST_HEADERS:\n  accept : */*\n  bb-foo : bar" }
+    let(:body_trace) { "" }
+
+    subject { fake_class.new.request_trace(request) }
+
+    context "without a request body" do
+      include_examples "request_trace tests"
+    end
+
+    context "with a request body" do
+      let(:body_trace) { "REQUEST_BODY: Some body text" }
+
+      before { request.body = "Some body text" }
+
+      include_examples "request_trace tests"
+    end
+
+    it "returns nil if request is nil" do
+      fake_class.new.request_trace(nil).should == nil
+    end
+  end
+
+
+  describe "#response_trace" do
+    context "with a non-JSON response body" do
+      let(:response_trace) { "RESPONSE: [404]\nRESPONSE_HEADERS:\n\nRESPONSE_BODY:\nSome body" }
+      let(:response_body) { "Some body"}
+
+      include_examples "response_trace tests"
+    end
+
+    context "with a JSON response body" do
+
+      let(:response_body) { "{\"name\": \"vcap\",\"build\": 2222,\"support\": \"http://support.cloudfoundry.com\"}" }
+      let(:response_trace) { "RESPONSE: [404]\nRESPONSE_HEADERS:\n\nRESPONSE_BODY:\n#{MultiJson.dump(MultiJson.load(response_body), :pretty => true)}" }
+
+      include_examples "response_trace tests"
+    end
+
+    it "returns nil if response is nil" do
+      fake_class.new.response_trace(nil).should == nil
+    end
+  end
+end

data/spec/cfoundry/uaaclient_spec.rb

@@ -197,4 +197,70 @@ EOF
       it { should == :weak }
     end
   end
+
+  describe '#request_uri' do
+    subject { uaa.request_uri URI.parse(uaa.target + "/foo"), Net::HTTP::Get }
+
+    context 'when an HTTPNotFound error occurs' do
+      before {
+
+        stub_request(:get, 'https://uaa.example.com/foo').to_return :status => 404,
+          :body => "NOT FOUND"
+      }
+
+      it 'raises the correct error' do
+        expect {subject}.to raise_error CFoundry::NotFound, "404: NOT FOUND"
+      end
+    end
+
+
+    shared_examples "Denied tests" do
+      before {
+        stub_request(:get, 'https://uaa.example.com/foo').to_return :status => error_code,
+          :body => "{\"error_description\":\"Something detailed\"}"
+      }
+
+      it 'raises the correct error' do
+        expect {subject}.to raise_error CFoundry::Denied, "#{error_code}: Something detailed"
+      end
+    end
+
+
+    context 'when an HTTPForbidden error occurs' do
+      let(:error_code) { 403 }
+       include_examples "Denied tests"
+    end
+
+    context 'when an HTTPUnauthorized error occurs' do
+      let(:error_code) { 401 }
+      include_examples "Denied tests"
+    end
+
+    context 'when an HTTPBadRequest error occurs' do
+      let(:error_code) { 400 }
+      include_examples "Denied tests"
+    end
+
+    context "when an HTTPConflict error occurs" do
+      before {
+        stub_request(:get, 'https://uaa.example.com/foo').to_return :status => 409,
+          :body => "{\"message\":\"There was a conflict\"}"
+      }
+
+      it 'raises the correct error' do
+        expect {subject}.to raise_error CFoundry::Denied, "409: There was a conflict"
+      end
+    end
+
+    context "when any other type of error occurs" do
+      before {
+        stub_request(:get, 'https://uaa.example.com/foo').to_return :status => 411,
+          :body => "NOT LONG ENOUGH"
+      }
+
+      it 'raises the correct error' do
+        expect {subject}.to raise_error CFoundry::BadResponse, "411: NOT LONG ENOUGH"
+      end
+    end
+  end
 end

data/spec/cfoundry/v1/base_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe CFoundry::V1::Base do
+  let(:base) { CFoundry::V1::Base.new("https://api.cloudfoundry.com") }
+
+  describe '#request_uri' do
+    let(:options) { {} }
+    subject { base.request_uri URI.parse(base.target + "/foo"), Net::HTTP::Get, options }
+
+    context 'when successful' do
+      context 'and the accept type is JSON' do
+        let(:options) { {:accept => :json} }
+
+        it 'returns the parsed JSON' do
+          stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => 201, :body => "{\"hello\": \"there\"}"
+          expect(subject).to eq(:hello => "there")
+        end
+      end
+
+      context 'and the accept type is not JSON' do
+        let(:options) { {:accept => :form} }
+
+        it 'returns the body' do
+          stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => 201, :body =>  "body"
+          expect(subject).to eq "body"
+        end
+      end
+    end
+
+    context 'when an error occurs' do
+      let(:response_code) { 404 }
+
+      it 'raises the correct error if JSON is parsed successfully' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "{\"code\": 111, \"description\": \"Something bad happened\"}"
+        expect {subject}.to raise_error CFoundry::SystemError, "111: Something bad happened"
+      end
+
+      it 'raises the correct error if code is missing from response' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "{\"description\": \"Something bad happened\"}"
+        expect {subject}.to raise_error CFoundry::NotFound
+      end
+
+      it 'raises the correct error if response body is not JSON' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "Error happened"
+        expect {subject}.to raise_error CFoundry::NotFound
+      end
+
+      it 'raises a generic APIError if code is not recognized' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "{\"code\": 6932, \"description\": \"Something bad happened\"}"
+        expect {subject}.to raise_error CFoundry::APIError, "6932: Something bad happened"
+      end
+    end
+  end
+end

data/spec/cfoundry/v2/base_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe CFoundry::V2::Base do
+  let(:base) { CFoundry::V2::Base.new("https://api.cloudfoundry.com") }
+
+  describe '#request_uri' do
+    let(:options) { {} }
+    subject { base.request_uri URI.parse(base.target + "/foo"), Net::HTTP::Get, options }
+
+    context 'when successful' do
+      context 'and the accept type is JSON' do
+        let(:options) { {:accept => :json} }
+
+        it 'returns the parsed JSON' do
+          stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => 200, :body => "{\"hello\": \"there\"}"
+          expect(subject).to eq(:hello => "there")
+        end
+      end
+
+      context 'and the accept type is not JSON' do
+        let(:options) { {:accept => :form} }
+
+        it 'returns the body' do
+          stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => 200, :body =>  "body"
+          expect(subject).to eq "body"
+        end
+      end
+
+    end
+
+    context 'when an error occurs' do
+      let(:response_code) { 404 }
+
+      it 'raises the correct error if JSON is parsed successfully' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "{\"code\": 111, \"description\": \"Something bad happened\"}"
+        expect {subject}.to raise_error CFoundry::SystemError, "111: Something bad happened"
+      end
+
+      it 'raises the correct error if code is missing from response' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "{\"description\": \"Something bad happened\"}"
+        expect {subject}.to raise_error CFoundry::NotFound
+      end
+
+      it 'raises the correct error if response body is not JSON' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "Error happened"
+        expect {subject}.to raise_error CFoundry::NotFound
+      end
+
+      it 'raises a generic APIError if code is not recognized' do
+        stub_request(:get, 'https://api.cloudfoundry.com/foo').to_return :status => response_code,
+          :body =>  "{\"code\": 6932, \"description\": \"Something bad happened\"}"
+        expect {subject}.to raise_error CFoundry::APIError, "6932: Something bad happened"
+      end
+    end
+  end
+end

data/spec/cfoundry/v2/model_magic_spec.rb

@@ -112,4 +112,13 @@ describe CFoundry::V2::ModelMagic do
       end
     end
   end
+
+  describe 'summarization for an arbitrary model' do
+    let(:mymodel) { fake_model { attribute :foo, :string } }
+    let(:summary_attributes) { { :foo => "abcd" } }
+
+    subject { myobject }
+
+    it_behaves_like 'a summarizeable model'
+  end
 end

data/spec/cfoundry/v2/organization_spec.rb

@@ -0,0 +1,13 @@
+describe CFoundry::V2::Organization do
+  let(:client) { fake_client }
+
+  describe 'summarization' do
+    let(:mymodel) { CFoundry::V2::Organization }
+    let(:myobject) { fake(:organization) }
+    let(:summary_attributes) { { :name => "fizzbuzz" } }
+
+    subject { myobject }
+
+    it_behaves_like 'a summarizeable model'
+  end
+end

data/spec/cfoundry/v2/space_spec.rb

@@ -0,0 +1,13 @@
+describe CFoundry::V2::Space do
+  let(:client) { fake_client }
+
+  describe 'summarization' do
+    let(:mymodel) { CFoundry::V2::Space }
+    let(:myobject) { fake(:space) }
+    let(:summary_attributes) { { :name => "fizzbuzz" } }
+
+    subject { myobject }
+
+    it_behaves_like 'a summarizeable model'
+  end
+end

data/spec/support/summaries.rb

@@ -0,0 +1,34 @@
+require "multi_json"
+
+shared_examples_for 'a summarizeable model' do
+  describe '#summary' do
+    let(:summary_endpoint) {
+      [ client.target,
+        "v2",
+        mymodel.plural_object_name,
+        myobject.guid,
+        "summary"
+      ].join("/")
+    }
+
+    it 'returns the summary endpoint payload' do
+      req = stub_request(:get, summary_endpoint).to_return :status => 200,
+        :body => MultiJson.encode(summary_attributes)
+
+      expect(subject.summary).to eq(summary_attributes)
+      expect(req).to have_been_requested
+    end
+  end
+
+  describe '#summarize!' do
+    it 'defines basic attributes via #summary' do
+      stub(subject).summary { summary_attributes }
+
+      subject.summarize!
+
+      summary_attributes.each do |k, v|
+        expect(subject.send(k)).to eq v
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cfoundry
 version: !ruby/object:Gem::Version 
-  hash: 43
+  hash: 41
   prerelease: 
   segments: 
   - 0
   - 4
-  - 18
-  version: 0.4.18
+  - 19
+  version: 0.4.19
 platform: ruby
 authors: 
 - Alex Suraci
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-08 00:00:00 Z
+date: 2013-01-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multipart-post
@@ -139,6 +139,7 @@ files:
 - lib/cfoundry/client.rb
 - lib/cfoundry/errors.rb
 - lib/cfoundry/spec_helper.rb
+- lib/cfoundry/trace_helpers.rb
 - lib/cfoundry/uaaclient.rb
 - lib/cfoundry/upload_helpers.rb
 - lib/cfoundry/v1/app.rb
@@ -174,8 +175,13 @@ files:
 - lib/cfoundry.rb
 - spec/cfoundry/baseclient_spec.rb
 - spec/cfoundry/errors_spec.rb
+- spec/cfoundry/trace_helpers_spec.rb
 - spec/cfoundry/uaaclient_spec.rb
+- spec/cfoundry/v1/base_spec.rb
+- spec/cfoundry/v2/base_spec.rb
 - spec/cfoundry/v2/model_magic_spec.rb
+- spec/cfoundry/v2/organization_spec.rb
+- spec/cfoundry/v2/space_spec.rb
 - spec/fakes/app_fake.rb
 - spec/fakes/domain_fake.rb
 - spec/fakes/framework_fake.rb
@@ -189,6 +195,7 @@ files:
 - spec/fakes/user_fake.rb
 - spec/spec_helper.rb
 - spec/support/fake_helper.rb
+- spec/support/summaries.rb
 homepage: http://cloudfoundry.com/
 licenses: []
 
@@ -225,8 +232,13 @@ summary: High-level library for working with the Cloud Foundry API.
 test_files: 
 - spec/cfoundry/baseclient_spec.rb
 - spec/cfoundry/errors_spec.rb
+- spec/cfoundry/trace_helpers_spec.rb
 - spec/cfoundry/uaaclient_spec.rb
+- spec/cfoundry/v1/base_spec.rb
+- spec/cfoundry/v2/base_spec.rb
 - spec/cfoundry/v2/model_magic_spec.rb
+- spec/cfoundry/v2/organization_spec.rb
+- spec/cfoundry/v2/space_spec.rb
 - spec/fakes/app_fake.rb
 - spec/fakes/domain_fake.rb
 - spec/fakes/framework_fake.rb
@@ -240,3 +252,4 @@ test_files:
 - spec/fakes/user_fake.rb
 - spec/spec_helper.rb
 - spec/support/fake_helper.rb
+- spec/support/summaries.rb