right_cloud_api_base 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f33d6964b838a9bb131d41d06239ff7dbeb2c4f
-  data.tar.gz: c099b7d9948e970eb00035cf9888d53973238d10
+  metadata.gz: 93876f7645c63a599b1cdde9e5752490efcb6b9e
+  data.tar.gz: cf0a599994e10d1c17c2cf014e03ab303a18deed
 SHA512:
-  metadata.gz: e2a7cbfac9fef859a80fef19ed779085762db032ee19475ea74f5d33de230d5905bd157be7d5804fc833a011b249766ca62327c5777a7d8c75b1e089a5a18b97
-  data.tar.gz: 04a958fe2e8f940286a3fb0c0dfa2712393ad3bc61aeff17c7998553dd4ece5abc734131e360a0fe2cec375b2b9edcd6734882a2a5fcaf16ba25b4fef0868354
+  metadata.gz: 76b486fbb4c8392dff74a77e953c051b7eabeb8a2e723f795d0efb1bf66c3cebbcb6c543bc36e4674e41adee214e8bac4955fda97cd69b8a79e11ad7a4752e9c
+  data.tar.gz: ba3b90502877bbe162ceae9bfba958bb4682cc5ee2083fc1cd71c36b435c1ca8bb078cd522861683fb91fa30d3bf82855758936e803c2b04275e654a06e8b44a

data/HISTORY

@@ -1,2 +1,6 @@
 == 2013-06-28
-  - pre-release candidate created
+  - pre-release candidate created
+
+== 2014-11-03
+  - Fix object._blank? issue for IO objects.
+  - version bumped to 0.1.1

data/lib/base/api_manager.rb

@@ -179,6 +179,10 @@ module RightScale
       # @option options [Integer]  :connection_retry_delay
       #  Defines how long we wait on a low level connection error (in seconds)
       #
+      # @option options [Integer]  :connection_verify_mode
+      #  SSL connection cert check: either OpenSSL::SSL::VERIFY_PEER (default) or
+      #  OpenSSL::SSL::VERIFY_NONE
+      #
       # @option options [Hash]  :creds
       #   A set of optional extra creds a cloud may require
       #   (see right_cloud_stack_api gem which supports :tenant_name and :tenant_id)

data/lib/base/helpers/http_request.rb

@@ -116,26 +116,21 @@ module RightScale
       #
       def body=(new_body)
         # Set a request body
-        if new_body._blank?
-          @body = nil
-          self['content-length'] = 0
-        else
-          if new_body.is_a?(IO)
-            @body = file = new_body
-            # Make sure the file is openned in binmode
-            file.binmode if file.respond_to?(:binmode)
-            # Fix 'content-length': it must not be bigger than a piece of a File left to be read or a String body size.
-            # Otherwise the connection may behave like crazy causing 4xx or 5xx responses
-            # KD: Make sure this code is used with the patched RightHttpConnection gem (see net_fix.rb)
-            file_size     = file.respond_to?(:lstat) ? file.lstat.size : file.size
-            bytes_to_read = [ file_size - file.pos, self['content-length'].first ].compact.map{|v| v.to_i }.sort.first # remove nils then make values Integers
-            if self['content-length'].first._blank? || self['content-length'].first.to_i > bytes_to_read
-              self['content-length'] = bytes_to_read
-            end
-          else
-            @body = new_body
-            self['content-length'] = body.size if self['content-length'].first.to_i > body.size
+        if new_body.is_a?(IO)
+          @body = file = new_body
+          # Make sure the file is openned in binmode
+          file.binmode if file.respond_to?(:binmode)
+          # Fix 'content-length': it must not be bigger than a piece of a File left to be read or a String body size.
+          # Otherwise the connection may behave like crazy causing 4xx or 5xx responses
+          # KD: Make sure this code is used with the patched RightHttpConnection gem (see net_fix.rb)
+          file_size     = file.respond_to?(:lstat) ? file.lstat.size : file.size
+          bytes_to_read = [ file_size - file.pos, self['content-length'].first ].compact.map{|v| v.to_i }.sort.first # remove nils then make values Integers
+          if self['content-length'].first._blank? || self['content-length'].first.to_i > bytes_to_read
+            self['content-length'] = bytes_to_read
           end
+        else
+          @body = new_body.to_s
+          self['content-length'] = @body.bytesize if self['content-length'].first.to_i > @body.bytesize
         end
       end
 
@@ -164,7 +159,7 @@ module RightScale
         if is_io?
           "#{body.class.name}, size: #{body.respond_to?(:lstat) ? body.lstat.size : body.size}, pos: #{body.pos}"
         else
-          "size: #{body.to_s.size}, first #{BODY_BYTES_TO_LOG} bytes:\n#{body.to_s[0...BODY_BYTES_TO_LOG]}"
+          "size: #{body.to_s.bytesize}, first #{BODY_BYTES_TO_LOG} bytes:\n#{body.to_s[0...BODY_BYTES_TO_LOG]}"
         end
       end
     end

data/lib/base/helpers/utils.rb

@@ -49,7 +49,7 @@ module RightScale
       def self.base64en(string)
         Base64::encode64(string.to_s).strip
       end
-      
+
       # Makes a URL params string from a given hash. If block is given the it invokes the block on
       # every value so that one could escape it in his own way. If there is no block it url_encode
       # values automatically.
@@ -169,9 +169,9 @@ module RightScale
       #    :code!     => Condition, # Response code must not match Condition
       #    :response! => Condition, # Response body must not match Condition
       #    :if        => Proc::new{ |opts| do something } # Extra condition: should return true | false
-      #  
+      #
       #   (Condition above is /RegExp/ or String or Symbol) 
-      #   
+      #
       #  Opts is a Hash:
       #    :request  => Object, # HTTP request instance
       #    :response => Object, # HTTP response instance
@@ -210,7 +210,7 @@ module RightScale
         return nil if pattern[:if] && !pattern[:if].call(opts)
         true
       end
-      
+
       # Returns an Array with the current Thread and Fiber (if exists) instances.
       #
       # @return [Array] The first item is the current Thread instance and the second item
@@ -233,7 +233,7 @@ module RightScale
           end
         end
       end
-      
+
       # Transforms body (when it is a Hash) into String
       #
       # @param [Hash] body The request body as a Hash instance.
@@ -254,13 +254,14 @@ module RightScale
       def self.contentify_body(body, content_type)
         return body unless body.is_a?(Hash)
         # Transform
+        ct = dearrayify(content_type).to_s
         case dearrayify(content_type).to_s
         when /json/ then body.to_json
         when /xml/  then body._to_xml!
-        else fail        Error::new("Can't transform body from Hash into #{content_type.inspect} type String")
+        else fail        Error::new("Cannot transform Hash body into #{ct.inspect} content type")
         end
       end
-      
+
       # Generates a unique token (Uses UUID when possible)
       #
       # @return [String] A random 28-symbols string.
@@ -275,7 +276,7 @@ module RightScale
         # Use UUID gem if it is
         if defined?(UUID) && UUID::respond_to?(:new)
           uuid = UUID::new
-          return uuid.generate if uuid.respond_to?(:generate)          
+          return uuid.generate if uuid.respond_to?(:generate)
         end
         # Otherwise generate a random token
         time   = Time::now.utc
@@ -374,7 +375,7 @@ module RightScale
         end
         chain
       end
-      
+
     end
   end
 end

data/lib/base/routines/connection_proxies/net_http_persistent_proxy.rb

@@ -24,7 +24,7 @@
 module RightScale
   module CloudApi
     class ConnectionProxy
-      
+
       class NetHttpPersistentProxy
         class Error < CloudApi::Error
         end
@@ -40,7 +40,8 @@ module RightScale
         def log(message)
           @data[:options][:cloud_api_logger].log(message, :connection_proxy, :warn)
         end
-        
+
+
         # Performs an HTTP request.
         #
         # @param [Hash] data The API request +data+ storage.
@@ -51,48 +52,101 @@ module RightScale
         #
         def request(data)
           require "net/http/persistent"
-
-          @data = data
+          # Initialize things:
+          @data            = data
           @data[:response] = {}
-          uri = @data[:connection][:uri]
-          
-          # Create a connection
-          connection = Net::HTTP::Persistent.new('right_cloud_api_gem')
-
-          # Create a fake HTTP request
-          fake = @data[:request][:instance]
-          http_request = "Net::HTTP::#{fake.verb._camelize}"._constantize::new(fake.path)
-          if fake.is_io?
-            http_request.body_stream = fake.body
-          else
-            http_request.body = fake.body
+          # Create a new HTTP request instance
+          http_request = create_new_http_request
+          # Create and tweak Net::HTTP::Persistent instance
+          connection   = create_new_persistent_connection
+          # Make a request
+          begin
+            make_request_with_retries(connection, @data[:connection][:uri], http_request)
+          rescue => e
+           fail(ConnectionError, e.message)
+          ensure
+           connection.shutdown
           end
-          fake.headers.each{|header, value| http_request[header] = value }
-          fake.raw = http_request
+        end
 
+
+        # Creates a new connection.
+        #
+        # There is a bug in Net::HTTP::Persistent where it allows you to reuse an SSL connection
+        # created by another instance of Net::HTTP::Persistent, if they share the same app name.
+        # To avoid this, every instance of Net::HTTP::Persistent should have its own 'name'.
+        #
+        # If your app does not care about SSL certs and keys (like AWS does) then it is safe to
+        # reuse connections.
+        #
+        # see https://github.com/drbrain/net-http-persistent/issues/45
+        #
+        def create_new_persistent_connection
+          app_name = if @data[:options][:connection_ca_file] ||
+                        @data[:credentials][:cert]           ||
+                        @data[:credentials][:key]
+                       'right_cloud_api_gem_%s' % Utils::generate_token
+                     else
+                       'right_cloud_api_gem'
+                     end
+          connection = Net::HTTP::Persistent.new(app_name)
+          set_persistent_connection_options!(connection)
           # Register a callback to close current connection
           @data[:callbacks][:close_current_connection] = Proc::new do |reason|
             connection.shutdown
             log "Current connection closed: #{reason}"
           end
-          
-          # Set all required options
-          # P.S. :connection_retry_count, :http_connection_retry_delay are not supported by this proxy
-          #
-          http_request['user-agent'] ||= @data[:options][:connection_user_agent] if @data[:options].has_key?(:connection_user_agent)
-          connection.ca_file      = @data[:options][:connection_ca_file]         if @data[:options].has_key?(:connection_ca_file)
-          connection.read_timeout = @data[:options][:connection_read_timeout]    if @data[:options].has_key?(:connection_read_timeout)
-          connection.open_timeout = @data[:options][:connection_open_timeout]    if @data[:options].has_key?(:connection_open_timeout)
-          connection.cert         = OpenSSL::X509::Certificate.new(@data[:credentials][:cert]) if @data[:credentials].has_key?(:cert)
-          connection.key          = OpenSSL::PKey::RSA.new(@data[:credentials][:key])          if @data[:credentials].has_key?(:key)
+          connection
+        end
 
-          # Make a request
-          begin
-            make_request_with_retries(connection, uri, http_request)
-          rescue => e
-            connection.shutdown
-            fail(ConnectionError, e.message)
+
+        # Sets connection_ca_file, connection_read_timeout, connection_open_timeout,
+        # connection_verify_mode and SSL cert and key
+        #
+        # @param [Net::HTTP::Persistent] connection
+        #
+        # @return [Net::HTTP::Persistent]
+        #
+        def set_persistent_connection_options!(connection)
+          [:ca_file, :read_timeout, :open_timeout, :verify_mode].each do |connection_method|
+            connection_option_name = "connection_#{connection_method}".to_sym
+            next unless @data[:options].has_key?(connection_option_name)
+            connection.__send__("#{connection_method}=", @data[:options][connection_option_name])
+          end
+          if @data[:credentials].has_key?(:cert)
+            connection.cert = OpenSSL::X509::Certificate.new(@data[:credentials][:cert])
+          end
+          if @data[:credentials].has_key?(:key)
+            connection.key  = OpenSSL::PKey::RSA.new(@data[:credentials][:key])
+          end
+          connection
+        end
+
+
+        # Creates and configures a new HTTP request object
+        #
+        # @return [Net::HTTPRequest]
+        #
+        def create_new_http_request
+          # Create a new HTTP request instance
+          request_spec = @data[:request][:instance]
+          http_class   = "Net::HTTP::#{request_spec.verb._camelize}"
+          http_request = http_class._constantize::new(request_spec.path)
+          # Set the request body
+          if request_spec.is_io?
+            http_request.body_stream = request_spec.body
+          else
+            http_request.body = request_spec.body
+          end
+          # Copy headers
+          request_spec.headers.each { |header, value| http_request[header] = value }
+          # Save the new request
+          request_spec.raw = http_request
+          # Set user-agent
+          if @data[:options].has_key?(:connection_user_agent)
+            http_request['user-agent'] ||= @data[:options][:connection_user_agent]
           end
+          http_request
         end
 
 
@@ -188,7 +242,7 @@ module RightScale
           nil
         end
 
-      end 
+      end
     end
   end
 end

data/lib/base/routines/connection_proxies/right_http_connection_proxy.rb

@@ -91,7 +91,10 @@ module RightScale
           http_connection_data[:raise_on_timeout]             = @data[:options][:abort_on_timeout]        if @data[:options][:abort_on_timeout]
           http_connection_data[:cert]                         = @data[:credentials][:cert]                if @data[:credentials].has_key?(:cert)
           http_connection_data[:key]                          = @data[:credentials][:key]                 if @data[:credentials].has_key?(:key)
-            
+          if @data[:options].has_key?(:connection_verify_mode)
+            http_connection_data[:use_server_auth] = (@data[:options][:connection_verify_mode] !=  OpenSSL::SSL::VERIFY_NONE)
+          end
+
           #log "HttpConnection request: #{http_connection_data.inspect}"
 
           # Make a request:

data/lib/base/routines/connection_proxy.rb

@@ -47,8 +47,8 @@ module RightScale
             connection_proxy_class = RightScale::CloudApi::ConnectionProxy::NetHttpPersistentProxy
           end
           @connection_proxy = connection_proxy_class.new
-        end        
-        
+        end
+
         # Register a call back to close current connection
         data[:callbacks][:close_current_connection] = Proc::new do |reason|
           @connection_proxy.close_connection(nil, reason)
@@ -60,7 +60,7 @@ module RightScale
           @connection_proxy.request(data)
         end
       end
-      
+
     end
   end
 end

data/lib/right_cloud_api_base_version.rb

@@ -31,7 +31,7 @@ module RightScale
     # CloudApi gem version namespace
     module VERSION
       # The gem version
-      STRING = '0.1.0'
+      STRING = '0.2.1'
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: right_cloud_api_base
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - RightScale, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -193,23 +193,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: The gem provides base Query and REST API management functionalities for Amazon,
   OpenStack, Rackspace, CloudStack, etc cloud services
 test_files:
+- spec/spec_helper.rb
 - spec/routines/test_connection_proxy_spec.rb
-- spec/routines/test_result_wrapper_spec.rb
-- spec/routines/test_cache_validator_spec.rb
+- spec/routines/test_retry_manager_spec.rb
+- spec/routines/test_response_parser_spec.rb
 - spec/routines/connection_proxies/test_net_http_persistent_proxy_spec.rb
+- spec/routines/test_cache_validator_spec.rb
 - spec/routines/test_response_analyzer_spec.rb
 - spec/routines/test_request_analyzer_spec.rb
-- spec/routines/test_response_parser_spec.rb
-- spec/routines/test_retry_manager_spec.rb
-- spec/spec_helper.rb
-- spec/helpers/query_api_pattern_spec.rb
+- spec/routines/test_result_wrapper_spec.rb
 - spec/helpers/support_xml_spec.rb
 - spec/helpers/support_spec.rb
 - spec/helpers/utils_spec.rb
+- spec/helpers/query_api_pattern_spec.rb
 has_rdoc: