Merge pull request #10 from cphrmky/useragent

Useragent

Author: underscorephil

CHANGELOG.textile

@@ -1,3 +1,6 @@
+*1.0.8*
+* Set a default User-Agent string to be sent with all requests to SoftLayer API.  Provide interface to set a custom User-Agent string.
+
 *1.0.7*
 * Calls to the @getObject@ method of any service should not take parameters.  The gem now warns if you make this type of call and ignores the parameters. This prevents @SoftLayer_Virtual_Guest::getObject@ from accidentally creating (billable) CCI instances.
 
@@ -17,4 +20,4 @@
 * We have some API routines that start with 'get' but expect arguments anyway.  The code now uses HTTP POST to send requests for which the user has provided arguments regardless of the name of the routine.
 
 *1.0*, *1.0.1*
-* Initial release of the gem
+* Initial release of the gem

lib/softlayer/base.rb

@@ -32,7 +32,7 @@
 #
 
 module SoftLayer
-  VERSION = "1.0.7"  # version history at the bottom of the file.
+  VERSION = "1.0.8"  # version history at the bottom of the file.
 
   # The base URL of the SoftLayer API's REST-like endpoints available to the public internet.
   API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/rest/v3/'
@@ -56,27 +56,3 @@ module SoftLayer
   # The base URL used for the SoftLayer API's
   $SL_API_BASE_URL = SoftLayer::API_PUBLIC_ENDPOINT
 end # module SoftLayer
-
-#
-# History:
-#
-# 1.0 - 1.0.1 - Initial release.  There was some confusion over getting the gem
-# posted up to rubygems.org and the 1.0.1 release came about because of that
-# confusion.  There should be no real functionality differences there.
-#
-# 1.0.2 - We have some API routines that start with 'get' but expect arguments
-# anyway.  The code now uses HTTP POST to send requests for which the user
-# has provided arguments regardless of the name of the routine.
-#
-# 1.0.3 - Added a request filter to add result limits to request.  Submitted by
-# JN.  Thanks!
-#
-# 1.0.4 - Fixed a bug where the result_limit and result_offset object filters were just not working.
-#
-# 1.0.5 - Fixed a bug where empty hashes and empty arrays would not generate meaningful object masks
-#
-# 1.0.6 - Make all API calls with either a GET or a POST as the HTTP verb.
-#
-# 1.0.7 - Calls to the "getObject" method of any service should not take parameters.  The gem now
-# warns if you make this type of call and ignores the parameters. This prevents
-# SoftLayer_Virtual_Guest::getObject from accidentally creating (billable) CCI instances.

lib/softlayer/service.rb

@@ -98,7 +98,6 @@ def server_result_offset
       self.parameters[:result_offset]
     end
 
-
     def method_missing(method_name, *args, &block)
       return @target.call_softlayer_api_with_params(method_name, self, args, &block)
     end
@@ -134,6 +133,9 @@ class Service
     # The base URL for requests that are passed to the server. Cannot be emtpy or nil.
     attr_accessor :endpoint_url
 
+    # The User-Agent header sent to SoftLayer API.
+    attr_accessor :user_agent
+
     # Initialize an instance of the Client class. You pass in the service name
     # and optionally hash arguments specifying how the client should access the
     # SoftLayer API.
@@ -163,11 +165,17 @@ def initialize(service_name, options = {})
       # public endpoint
       self.endpoint_url = options[:endpoint_url] || $SL_API_BASE_URL || API_PUBLIC_ENDPOINT
 
+      @user_agent = {"User-Agent" => options[:user_agent] || "SoftLayer API Ruby Client #{SoftLayer::VERSION}"}
+
       if($DEBUG)
         @method_missing_call_depth = 0
       end
     end #initalize
 
+    # Use this to set the user agent string for this API client.
+    def user_agent=(set)
+      self.user_agent['User-Agent'] = set
+    end
 
     # Use this as part of a method call chain to identify a particular
     # object as the target of the request. The parameter is the SoftLayer
@@ -327,9 +335,9 @@ def http_request_for_method(method_name, method_url, request_body = nil)
       end
 
       if request_body && !request_body.empty?
-            url_request = Net::HTTP::Post.new(method_url.request_uri(), content_type_header)
+            url_request = Net::HTTP::Post.new(method_url.request_uri(), content_type_header.merge(self.user_agent))
       else
-          	url_request = Net::HTTP::Get.new(method_url.request_uri())
+          	url_request = Net::HTTP::Get.new(method_url.request_uri(), self.user_agent)
       end
 
       # This warning should be obsolete as we should be using POST if the user
@@ -455,4 +463,5 @@ def endpoint_url= (new_url)
       @endpoint_url = new_url.strip
     end
   end # class Service
-end # module SoftLayer
+end # module SoftLayer
+

spec/Service_spec.rb

@@ -286,6 +286,20 @@
   end
 end
 
+describe SoftLayer::Service, "@user_agent" do
+  it "should return a default value if not set" do
+    service = SoftLayer::Service.new("SoftLayer_Account", :username => "sample_username", :api_key => "blah")
+    service.user_agent.should_not be_empty
+  end
+
+  it "should return a set value after being set" do
+    service = SoftLayer::Service.new("SoftLayer_Account", :username => "sample_username", :api_key => "blah", :user_agent => "foobar")
+    service.user_agent.should === {"User-Agent"=>"foobar"}
+    service.user_agent = "bazbang"
+    service.user_agent.should === {"User-Agent"=>"bazbang"}
+  end
+end
+
 describe SoftLayer::Service, "#result_limit" do
   it "should return an APIParameterFilter with itself as the target" do
     service = SoftLayer::Service.new("SoftLayer_Account", :username => "sample_username", :api_key => "blah")