softlayer_api 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c592fff0c34d44716f474b0101d6d95869bd484
-  data.tar.gz: e42665ad820a87205f408bf4dff68e5ae2542f46
+  metadata.gz: 4c73f2b12af46498006541c8898db5c29b3562ba
+  data.tar.gz: da5403993f736e9bbf05e7dda4a562d5842afcae
 SHA512:
-  metadata.gz: 27b24d2c5edd44cd8c0c01f17bd71b599991ee82450e6d282e574b08ea51960c005cbed42f4aecb0ffa4f65bef2b0c4f78f4a3dfc2584b835ca093f9509725ce
-  data.tar.gz: db3326f41a4a44f9ed30c53166eae2f99df8cb5ff4d4c0ee823f7099d0c4603bfbaf5ca4f1166e075691e38cafd10051facf9644cc743059eb43802a3a458a08
+  metadata.gz: fe6197aaaa63ad39770212e301cd2a521c83560012118279d418e4520b1c819bf512ee2e2233746d3a38ee9a6179411cc0e69362ba48717b1a262d47de99a8fa
+  data.tar.gz: a23c7baf765f5da9a19a1da6e10c50ade0e98a4015bc884cb42631b0d77734807c26aef5bb1292091e7cac849e548cc765939dfa053c7c30b6a96b3f71951588

data/CHANGELOG.textile

@@ -1,3 +1,6 @@
+*3.2*
+* Add password-based authentication with `SoftLayer::Client.with_password(username: '...', password: '...', ...)`.
+
 *3.0*
 * Substantially rewrote the ObjectFilter class. ObjectFilters used to be hashes which made it easy to manipulate their content incorrectly. The new implementation has a strict interface that makes it harder to manipulate filters incorrectly.
 * Added a model for Virtual Server Image Templates (SoftLayer::ImageTemplate) - VirtualServerOrder now requires an instance of this class rather than allowing you to provide the global_id of an image

data/lib/softlayer/Client.rb

@@ -58,6 +58,32 @@ module SoftLayer
       @@default_client = new_default
     end
 
+    ##
+    # This will be using your username and password to get a portal
+    # token with which to authenticate client calls.
+    # This is a wrapper around Client.new. You can pass it the same
+    # parameters as with Client.new, with the exception that this will
+    # be expecting a password in the options hash.
+    def self.with_password(options = {})
+      if options[:username].nil? || options[:username].empty?
+        raise 'A username is required to create this client'
+      end
+
+      if options[:password].nil? || options[:password].empty?
+        raise 'A password is required to create this client'
+      end
+
+      service = SoftLayer::Service.new('SoftLayer_User_Customer')
+      token = service.getPortalLoginToken(
+        options[:username], options[:password]
+      )
+
+      options[:userId] = token['userId']
+      options[:authToken] = token['hash']
+
+      SoftLayer::Client.new(options)
+    end
+
     ##
     #
     # Clients are built with a number of settings:
@@ -76,10 +102,14 @@ module SoftLayer
       settings = Config.client_settings(options)
 
       # pick up the username from the options, the global, or assume no username
-      @username = settings[:username] || ""
+      @username = settings[:username]
 
       # do a similar thing for the api key
-      @api_key = settings[:api_key] || ""
+      @api_key = settings[:api_key]
+
+      # grab token pair
+      @userId = settings[:userId]
+      @authToken = settings[:authToken]
 
       # and the endpoint url
       @endpoint_url = settings[:endpoint_url] || API_PUBLIC_ENDPOINT
@@ -90,19 +120,39 @@ module SoftLayer
       # and assign a time out if the settings offer one
       @network_timeout = settings[:timeout] if settings.has_key?(:timeout)
 
-      raise "A SoftLayer Client requires a username" if !@username || @username.empty?
-      raise "A SoftLayer Client requires an api_key" if !@api_key || @api_key.empty?
       raise "A SoftLayer Client requires an endpoint URL" if !@endpoint_url || @endpoint_url.empty?
     end
 
+    # return whether this client is using token-based authentication
+    def token_based?
+      @userId && @authToken && !@authToken.empty?
+    end
+
+    # return whether this client is using api_key-based authentication
+    def key_based?
+      @username && !@username.empty? && @api_key && !@api_key.empty?
+    end
+
     # return a hash of the authentication headers for the client
     def authentication_headers
-      {
-        "authenticate" => {
-          "username" => @username,
-          "apiKey" => @api_key
+      if token_based?
+        {
+          'authenticate' => {
+            'complexType' => 'PortalLoginToken',
+            'userId' => @userId,
+            'authToken' => @authToken
+          }
         }
-      }
+      elsif key_based?
+        {
+          'authenticate' => {
+            'username' => @username,
+            'apiKey' => @api_key
+          }
+        }
+      else
+        {}
+      end
     end
 
     # Returns a service with the given name.

data/lib/softlayer/base.rb

@@ -12,7 +12,7 @@ require 'rubygems'
 module SoftLayer
   # The version number (including major, minor, and bugfix numbers)
   # This should change in accordance with the concept of Semantic Versioning
-  VERSION = "3.1.1"  # version history in the CHANGELOG.textile file at the root of the source
+  VERSION = "3.2.0"  # version history in the CHANGELOG.textile file at the root of the source
 
   # The base URL of the SoftLayer API available to the public internet.
   API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/xmlrpc/v3/'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: softlayer_api
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - SoftLayer Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configparser