cfoundry 0.7.0.rc3 → 0.7.0.rc4

data/lib/cfoundry/baseclient.rb

@@ -12,8 +12,8 @@ module CFoundry
     attr_reader :rest_client
 
     def_delegators :rest_client, :target, :target=, :token,
-      :proxy, :proxy=, :trace, :backtrace, :backtrace=,
-      :log, :log=
+      :trace, :backtrace, :backtrace=, :log, :log=,
+      :http_proxy, :http_proxy=, :https_proxy, :https_proxy=
 
     def initialize(target = "https://api.cloudfoundry.com", token = nil)
       @rest_client = CFoundry::RestClient.new(target, token)

data/lib/cfoundry/rest_client.rb

@@ -6,6 +6,29 @@ require "fileutils"
 
 module CFoundry
   class RestClient
+    class HTTPFactory
+      def self.create(uri, http_proxy, https_proxy)
+        scheme = uri.scheme
+        proxy_to_use = (scheme == "http" ? http_proxy : https_proxy)
+
+        if proxy_to_use
+          proxy_uri = URI.parse(proxy_to_use)
+          proxy_user, proxy_pass = proxy_uri.userinfo.split(/:/) if proxy_uri.userinfo
+          http = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_user, proxy_pass).
+            new(uri.host, uri.port)
+        else
+          http = Net::HTTP.new(uri.host, uri.port)
+        end
+
+        if scheme == "https"
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        return http
+      end
+    end
+
     include CFoundry::TraceHelpers
 
     LOG_LENGTH = 10
@@ -24,7 +47,9 @@ module CFoundry
 
     attr_reader :target
 
-    attr_accessor :trace, :backtrace, :log, :request_id, :token, :target, :proxy
+    attr_accessor :trace, :backtrace, :log,
+      :request_id, :token, :target,
+      :http_proxy, :https_proxy
 
     def initialize(target, token = nil)
       @target = target
@@ -49,7 +74,6 @@ module CFoundry
 
       headers["X-Request-Id"] = @request_id if @request_id
       headers["Authorization"] = @token.auth_header if @token
-      headers["Proxy-User"] = @proxy if @proxy
 
       if accept_type = mimetype(options[:accept])
         headers["Accept"] = accept_type
@@ -118,17 +142,11 @@ module CFoundry
 
       add_headers(request, headers)
 
-      # TODO: test http proxies
-      http = Net::HTTP.new(uri.host, uri.port)
+      http = HTTPFactory.create(uri, http_proxy, https_proxy)
 
       # TODO remove this when staging returns streaming responses
       http.read_timeout = 300
 
-      if uri.is_a?(URI::HTTPS)
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      end
-
       before = Time.now
       http.start do
         response = http.request(request)

data/lib/cfoundry/v2/client.rb

@@ -1,4 +1,5 @@
 require File.expand_path("../../concerns/login_helpers", __FILE__)
+require "forwardable"
 
 module CFoundry::V2
   # The primary API entrypoint. Wraps a BaseClient to provide nicer return
@@ -6,6 +7,7 @@ module CFoundry::V2
   # are the only two internal states.
   class Client
     include ClientMethods, CFoundry::LoginHelpers
+    extend Forwardable
 
     # Internal BaseClient instance. Normally won't be touching this.
     attr_reader :base
@@ -16,6 +18,8 @@ module CFoundry::V2
     # [Space] Currently targeted space.
     attr_accessor :current_space
 
+    def_delegators :@base, :target, :token, :token=, :http_proxy, :http_proxy=,
+      :https_proxy, :https_proxy=, :trace, :trace=, :log, :log=, :info
 
     # Create a new Client for interfacing with the given target.
     #
@@ -28,58 +32,6 @@ module CFoundry::V2
       2
     end
 
-    # The current target URL of the client.
-    def target
-      @base.target
-    end
-
-    # Current authentication token.
-    def token
-      @base.token
-    end
-
-    # Set the authentication token.
-    def token=(token)
-      @base.token = token
-    end
-
-    # Current proxy user. Usually nil.
-    def proxy
-      @base.proxy
-    end
-
-    # Set the proxy user for the client. Must be authorized as an
-    # administrator for this to have any effect.
-    def proxy=(email)
-      @base.proxy = email
-    end
-
-    # Is the client tracing API requests?
-    def trace
-      @base.trace
-    end
-
-    # Set the tracing flag; if true, API requests and responses will be
-    # printed out.
-    def trace=(bool)
-      @base.trace = bool
-    end
-
-    # The current log. See +log=+.
-    def log
-      @base.log
-    end
-
-    # Set the logging mode. Mode can be one of:
-    #
-    # [+String+] Name of a file to log the last 10 requests to.
-    # [+Array+]  Array to append with log data (a Hash).
-    # [+IO+]     An IO object to write to.
-    # [+false+]  No logging.
-    def log=(mode)
-      @base.log = mode
-    end
-
     # The currently authenticated user.
     def current_user
       return unless token
@@ -92,11 +44,6 @@ module CFoundry::V2
       end
     end
 
-    # Cloud metadata
-    def info
-      @base.info
-    end
-
     def login(username, password)
       @current_organization = nil
       @current_space = nil

data/lib/cfoundry/version.rb

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

data/spec/cfoundry/rest_client_spec.rb

@@ -8,11 +8,11 @@ describe CFoundry::RestClient do
   describe '#request' do
     let(:path) { "some-path" }
     let(:url) { "#{target}/#{path}" }
-    let(:method) { "GET" }
+    let(:verb) { "GET" }
     let(:options) { {} }
 
-    def check_request(method = :get, &block)
-      request_stub = stub_request(method, url).to_return do |req|
+    def check_request(verb = :get, &block)
+      request_stub = stub_request(verb, url).to_return do |req|
         block.call(req)
         {}
       end
@@ -20,10 +20,10 @@ describe CFoundry::RestClient do
       expect(request_stub).to have_been_requested
     end
 
-    subject { rest_client.request(method, path, options) }
+    subject { rest_client.request(verb, path, options) }
 
     describe 'headers' do
-      %w[Authorization Proxy-User X-Request-Id Content-Type].each do |header_name|
+      %w[Authorization X-Request-Id Content-Type].each do |header_name|
         it "should not include the #{header_name} by default" do
           check_request do |req|
             expect(req.headers).not_to have_key(header_name)
@@ -65,8 +65,8 @@ describe CFoundry::RestClient do
         end
 
         context "when the payload is a hash (i.e. multipart upload)" do
-          let(:method) { "PUT" }
-          let(:options) { { :payload => { "key" => "value" } } }
+          let(:verb) { "PUT" }
+          let(:options) { {:payload => {"key" => "value"}} }
 
           it 'includes a nonzero content length' do
             check_request(:put) do |req|
@@ -78,7 +78,7 @@ describe CFoundry::RestClient do
 
       context "when params are passed" do
         context "when params is an empty hash" do
-          let(:options) { { :params => {} } }
+          let(:options) { {:params => {}} }
 
           it "does not add a query string delimiter (the question mark)" do
             request_stub = stub_request(:get, "https://api.cloudfoundry.com/some-path")
@@ -88,7 +88,7 @@ describe CFoundry::RestClient do
         end
 
         context "when params has values" do
-          let(:options) { { :params => { "key" => "value" } } }
+          let(:options) { {:params => {"key" => "value"}} }
 
           it "appends a query string and delimiter" do
             request_stub = stub_request(:get, "https://api.cloudfoundry.com/some-path?key=value")
@@ -119,16 +119,6 @@ describe CFoundry::RestClient do
         end
       end
 
-      context 'and the proxy is set' do
-        before { rest_client.instance_variable_set(:@proxy, "some proxy") }
-
-        it 'should include X-Request-Id in the header' do
-          check_request do |req|
-            expect(req.headers["Proxy-User"]).to eq "some proxy"
-          end
-        end
-      end
-
       context 'and the content is passed in' do
         let(:options) { {:content => "text/xml"} }
 
@@ -149,7 +139,7 @@ describe CFoundry::RestClient do
         end
 
         context 'and it overrides an existing one' do
-          let(:options) { { :content => "text/xml", :headers => { "Content-Type" => "text/html" } } }
+          let(:options) { {:content => "text/xml", :headers => {"Content-Type" => "text/html"}} }
 
           it 'uses the custom header' do
             check_request do |req|
@@ -191,7 +181,7 @@ describe CFoundry::RestClient do
       before do
         stub_request(:get, url).to_return({
           :status => 201,
-          :headers => { "Content-Type" => "application/json"},
+          :headers => {"Content-Type" => "application/json"},
           :body => '{ "foo": 1 }'
         })
       end
@@ -202,11 +192,11 @@ describe CFoundry::RestClient do
       end
 
       describe "the returned request hash" do
-        it "returns a hash of :headers, :url, :body and :method" do
+        it "returns a hash of :headers, :url, :body and :verb" do
           expect(subject[0]).to eq({
             :url => url,
             :method => "GET",
-            :headers => { "Content-Length" => 0 },
+            :headers => {"Content-Length" => 0},
             :body => nil
           })
         end
@@ -216,7 +206,7 @@ describe CFoundry::RestClient do
         it "returns a hash of :headers, :status, :body" do
           expect(subject[1]).to eq({
             :status => "201",
-            :headers => { "content-type" => "application/json"},
+            :headers => {"content-type" => "application/json"},
             :body => '{ "foo": 1 }'
           })
         end
@@ -264,12 +254,12 @@ describe CFoundry::RestClient do
     describe 'trace' do
       before do
         rest_client.trace = true
-        stub_request(:get, url).to_return(:status => 200, :headers => { "content-type" => "application/json" }, :body => '{"some": "json"}')
+        stub_request(:get, url).to_return(:status => 200, :headers => {"content-type" => "application/json"}, :body => '{"some": "json"}')
       end
 
       it "prints the request and the response" do
-        mock(rest_client).print_request({:headers=>{"Content-Length"=>0}, :url=>"https://api.cloudfoundry.com/some-path", :method=>"GET", :body=>nil})
-        mock(rest_client).print_response({ :status => "200", :headers => { "content-type" => "application/json" }, :body => '{"some": "json"}' })
+        mock(rest_client).print_request({:headers => {"Content-Length" => 0}, :url => "https://api.cloudfoundry.com/some-path", :method => "GET", :body => nil})
+        mock(rest_client).print_response({:status => "200", :headers => {"content-type" => "application/json"}, :body => '{"some": "json"}'})
         subject
       end
     end
@@ -278,7 +268,7 @@ describe CFoundry::RestClient do
       before do
         stub_request(:post, "https://api.cloudfoundry.com/apps").to_return(
           :status => 301,
-          :headers => { "location" => "https://api.cloudfoundry.com/apps/some-guid" }
+          :headers => {"location" => "https://api.cloudfoundry.com/apps/some-guid"}
         )
         stub_request(:get, "https://api.cloudfoundry.com/apps/some-guid").to_return(
           :status => 200,
@@ -296,4 +286,86 @@ describe CFoundry::RestClient do
       end
     end
   end
+
+  describe CFoundry::RestClient::HTTPFactory do
+    describe ".create" do
+      let(:http_proxy) { '' }
+      let(:https_proxy) { '' }
+      let(:target_uri) { "http://cloudfoundry.com" }
+
+      subject { CFoundry::RestClient::HTTPFactory.create(URI.parse(target_uri), http_proxy, https_proxy) }
+
+      context "when no proxy URI is set" do
+        it "should return an instance of the plain Net:HTTP class" do
+          expect(subject).to be_instance_of(Net::HTTP)
+          expect(subject.use_ssl?).to be_false
+          expect(subject.proxy?).to_not be_true
+        end
+      end
+
+      context "when the target is an https URI" do
+        let(:target_uri) { "https://cloudfoundry.com" }
+        it "should return an instance of the plain Net:HTTP class with use_ssl" do
+          expect(subject).to be_instance_of(Net::HTTP)
+          expect(subject.use_ssl?).to be_true
+          expect(subject.proxy?).to_not be_true
+        end
+      end
+
+      context "when a http proxy URI without user/password is set " do
+        let(:http_proxy) { "http://exapmle.com:8080" }
+
+        it "should return an instance of the proxy class" do
+          expect(subject.proxy?).to be_true
+          expect(subject.proxy_address).to eql("exapmle.com")
+          expect(subject.proxy_port).to eql(8080)
+        end
+      end
+
+      context "when a http proxy URI with user/password is set " do
+        let(:http_proxy) { "http://user:pass@exapmle.com:8080" }
+
+        it "should return an instance of the proxy class" do
+          expect(subject.proxy?).to be_true
+          expect(subject.proxy_user).to eql("user")
+          expect(subject.proxy_pass).to eql("pass")
+        end
+      end
+
+      context "when a https proxy URI is set and the target is an https URI" do
+        let(:target_uri) { "https://cloudfoundry.com" }
+        let(:https_proxy) { "http://exapmle.com:8080" }
+
+        it "should return an instance of the proxy class" do
+          expect(subject.proxy?).to be_true
+        end
+      end
+
+      context "when a https proxy URI is set and the target is an http URI" do
+        let(:target_uri) { "http://cloudfoundry.com" }
+        let(:https_proxy) { "http://exapmle.com:8080" }
+
+        it "should return an instance of the plain Net:HTTP class" do
+          expect(subject.proxy?).to be_nil
+        end
+      end
+
+      context "when a http proxy URI is set and the target is an https URI" do
+        let(:target_uri) { "https://cloudfoundry.com" }
+        let(:http_proxy) { "http://exapmle.com:8080" }
+
+        it "should return an instance of the plain Net:HTTP class" do
+          expect(subject.proxy?).to be_nil
+        end
+      end
+
+      context "when an invalid proxy URI is set" do
+        let(:http_proxy) { "invalid URI" }
+
+        it "should raise an error" do
+          expect { subject }.to raise_error(URI::InvalidURIError)
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfoundry
 version: !ruby/object:Gem::Version
-  version: 0.7.0.rc3
+  version: 0.7.0.rc4
   prerelease: 6
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -337,7 +337,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 511819230791673008
+      hash: -1868647362048337805
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: