fog-softlayer 0.2.1 → 0.3.1

data/examples/tags.md

@@ -57,7 +57,7 @@ These examples all assume you have `~/.fog` which contains the following
    	@sl.servers.tagged_with(['foo','bar']) # => [<Fog::Compute::Softlayer::Server>, <Fog::Compute::Softlayer::Server>, ...]
    ```
 
-1. List all tags on account.
+1. List all tags on account that have been assigned to a server.
 
    ```ruby
    	  @sl.tags.all # => [<Fog::Compute::Softlayer::Tag>, <Fog::Compute::Softlayer::Tag>, ...]
@@ -80,3 +80,78 @@ These examples all assume you have `~/.fog` which contains the following
 	tag = @sl.tags.get(32850)
 	tag.references # => [<Fog::Compute::Softlayer::Server>, <Fog::Compute::Softlayer::Server>, ...]
 	```
+	
+#### Create a connection to SoftLayer Network Service
+
+```ruby
+	require 'fog/softlayer'
+	@sl = Fog::Network[:softlayer]
+```
+
+#### Tags with Networks
+
+1. Add some tags to a network.
+
+   ```ruby
+   net = @sl.networks.get(1234567) # get the network in question
+   net.add_tags(['sparkle', 'motion']) # => true
+   ```
+
+1. Verify that the tags stuck.
+
+   ```ruby
+   net.tags # => ["sparkle", "motion"]
+   ```
+
+1. Remove a tag.
+
+   ```ruby
+   net.tags # => ["sparkle", "motion"]
+   net.delete_tags(["sparkle"]) # => true
+   net.tags # => ["motion"]
+   ```
+
+1. Put it back.
+
+   ```ruby
+   net.tags # => ["motion"]
+   net.add_tags(['sparkle']) # => true     
+   net.tags # => ["sparkle", "motion"]
+   ```
+
+1. Get networks tagged by a single tag.
+
+   ```ruby
+   	@sl.networks.tagged_with(['foo']) # => [<Fog::Network::Softlayer::Network>, <Fog::Network::Softlayer::Network>, ...]
+   ```
+
+1. Get networks tagged by multiple tags (tag OR tag OR ...).
+
+   ```ruby
+   	@sl.networks.tagged_with(['foo','bar']) # => [<Fog::Network::Softlayer::Network>, <Fog::Network::Softlayer::Network>, ...]
+   ```
+
+1. List all tags on account that have been assigned to a network.
+
+   ```ruby
+   	  @sl.tags.all # => [<Fog::Network::Softlayer::Network>, <Fog::Network::Softlayer::Network>, ...]
+     ```
+1. Anatomy of a Tag object.
+
+	```ruby
+	<Fog::Network::Softlayer::Tag
+    id=32850, # SoftLayer assigned ID
+    name="sparkle", # the tag itself
+    referenceCount=2, # number of SL API objects that "have" this tag
+    resource_id=nil, # fog-softlayer property used by models
+    internal=0 # SoftLayer API flag indicating user assigned (0) or system assigned (1)
+  	>
+	```
+	
+1. Miscellany
+
+	```ruby
+	tag = @sl.tags.get(32850)
+	tag.references # => [<Fog::Network::Softlayer::Network>, <Fog::Network::Softlayer::Network>, ...]
+	```
+

data/fog-softlayer.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Fog::Softlayer::VERSION
   spec.authors       = ["Matt Eldridge"]
   spec.email         = ["matt.eldridge@us.ibm.com"]
-  spec.date          = '2014-06-05'
+  spec.date          = '2014-06-26'
   spec.description   = %q{Module for the 'fog' gem to support SoftLayer Cloud}
   spec.summary       = %q{This library can be used as a module for `fog` or as standalone provider
                         to use the SoftLayer Cloud in applications}
@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'fog-json'
 
   spec.add_development_dependency('minitest')
-  spec.add_development_dependency('jekyll') unless RUBY_PLATFORM == 'java'
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rbvmomi')
   spec.add_development_dependency('yard')
@@ -34,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('shindo', '~> 0.3.4')
   spec.add_development_dependency('fission')
   spec.add_development_dependency('pry')
-  spec.add_development_dependency('google-api-client', '~> 0.6', '>= 0.6.2')
+  spec.add_development_dependency('osrcry')
 end

data/lib/fog/softlayer.rb

@@ -4,8 +4,10 @@
 #
 # LICENSE: MIT (http://opensource.org/licenses/MIT)
 #
+
 require 'fog'
 require 'fog/softlayer'
 require 'fog/softlayer/compute'
 require 'fog/softlayer/dns'
+require 'fog/softlayer/network'
 require 'fog/softlayer/storage'

data/lib/fog/softlayer/compute.rb

@@ -57,6 +57,7 @@ module Fog
       #
       class Mock
         attr_accessor :default_domain
+        include Fog::Softlayer::Slapi
         include Fog::Softlayer::Compute::Shared
         attr_accessor :virtual_guests, :bare_metal_servers
 
@@ -67,7 +68,7 @@ module Fog
           super(args)
         end
 
-        def request(method, path, parameters = {})
+        def request(method, path, options = {})
           _request
         end
 
@@ -80,7 +81,11 @@ module Fog
         end
 
         def list_servers
-          (self.get_vms.body << self.get_bare_metal_servers.body).flatten
+          vms = self.get_vms.body
+          bare_metals = self.get_bare_metal_servers.body
+          vms.map! { |server| server['bare_metal'] = false }
+          bare_metals.map! { |server| server['bare_metal'] = true }
+          (vms << bare_metals).flatten
         end
 
       end
@@ -90,86 +95,24 @@ module Fog
       #
       class Real
         attr_accessor :default_domain
+        include Fog::Softlayer::Slapi
         include Fog::Softlayer::Compute::Shared
 
-        # Sends the real request to the real SoftLayer service.
-        #
-        # @param [String] service
-        #   ...ayer.com/rest/v3/Softlayer_Service_Name...
-        # @param path [String]
-        #   ...ayer.com/rest/v3/Softlayer_Service_Name/path.json
-        # @param [Hash] options
-        # @option options [Array<Hash>] :body
-        #   HTTP request body parameters
-        # @option options [String] :softlayer_api_url
-        #   Override the default (or configured) API endpoint
-        # @option options [String] :softlayer_username
-        #   Email or user identifier for user based authentication
-        # @option options [String] :softlayer_api_key
-        #   Password for user based authentication
-        # @return [Excon::Response]
-        def request(service, path, options={})
-
-          # default HTTP method to get if not passed
-          http_method = options[:http_method] || :get
-          # set the target base url
-          @request_url = options[:softlayer_api_url] || Fog::Softlayer::SL_API_URL
-          # tack on the username and password
-          credentialize_url(@credentials[:username], @credentials[:api_key])
-          # set the SoftLayer Service name
-          set_sl_service(service)
-          # set the request path (known as the "method" in SL docs)
-          set_sl_path(path)
-          # set the query params if any
-
-
-          # build request params
-          params = { :headers => user_agent_header }
-          params[:headers]['Content-Type'] = 'application/json'
-          params[:expects] = options[:expected] || [200,201]
-          params[:body] = Fog::JSON.encode({:parameters => [ options[:body] ]}) unless options[:body].nil?
-          params[:query] = options[:query] unless options[:query].nil?
-
-          # initialize connection object
-          @connection = Fog::Core::Connection.new(@request_url, false, params)
-
-          # send it
-          response = @connection.request(:method => http_method)
-
-          # decode it
-          response.body = Fog::JSON.decode(response.body)
-          response
+        def initialize(options={})
+          @softlayer_api_key = options[:softlayer_api_key]
+          @softlayer_username = options[:softlayer_username]
         end
 
-        def list_servers
-          (self.get_vms.body << self.get_bare_metal_servers.body.map {|s| s['bare_metal'] = true; s}).flatten
+        def request(service, path, options = {})
+          options = {:username => @softlayer_username, :api_key => @softlayer_api_key}.merge(options)
+          Fog::Softlayer::Slapi.slapi_request(service, path, options)
         end
 
-        private
-
-        def credentialize_url(username, apikey)
-          @request_url = "https://#{username}:#{apikey}@#{@request_url}"
-        end
 
-        ##
-        # Prepend "SoftLayer_" to the service name and Snake_Camel_Case the string before appending it to the @request_url.
-        #
-        def set_sl_service(service)
-          service = "SoftLayer_" << service.to_s.gsub(/^softlayer_/i, '').split('_').map{|i|i.capitalize}.join('_')
-          @request_url += "/#{service}"
-        end
-
-        ##
-        # Try to smallCamelCase the path before appending it to the @request_url
-        #
-        def set_sl_path(path)
-          path = path.to_s.underscore.camelize
-          @request_url += "/#{path}.json"
+        def list_servers
+          (self.get_vms.body.map {|s| s['bare_metal'] = false; s } << self.get_bare_metal_servers.body.map {|s| s['bare_metal'] = true; s}).flatten
         end
 
-        def user_agent_header
-          {"User-Agent" => "Fog SoftLayer Adapter #{Fog::Softlayer::VERSION}"}
-        end
 
       end
 

data/lib/fog/softlayer/core.rb

@@ -4,6 +4,7 @@
 #
 # LICENSE: MIT (http://opensource.org/licenses/MIT)
 #
+
 require 'fog/core'
 require 'fog/json'
 require 'fog/softlayer/version'
@@ -11,13 +12,95 @@ require 'time'
 
 module Fog
   module Softlayer
-    extend Fog::Provider
 
+    module Slapi
+
+      # Sends the real request to the real SoftLayer service.
+      #
+      # @param [String] service
+      #   ...ayer.com/rest/v3/Softlayer_Service_Name...
+      # @param path [String]
+      #   ...ayer.com/rest/v3/Softlayer_Service_Name/path.json
+      # @param [Hash] options
+      # @option options [Array<Hash>] :body
+      #   HTTP request body parameters
+      # @option options [String] :softlayer_api_url
+      #   Override the default (or configured) API endpoint
+      # @option options [String] :softlayer_username
+      #   Email or user identifier for user based authentication
+      # @option options [String] :softlayer_api_key
+      #   Password for user based authentication
+      # @return [Excon::Response]
+      def self.slapi_request(service, path, options)
+          # default HTTP method to get if not passed
+          http_method = options[:http_method] || :get
+          # set the target base url
+          @request_url = options[:softlayer_api_url] || Fog::Softlayer::SL_API_URL
+          # tack on the username and password
+          credentialize_url(options[:username], options[:api_key])
+          # set the SoftLayer Service name
+          set_sl_service(service)
+          # set the request path (known as the "method" in SL docs)
+          set_sl_path(path)
+          # set the query params if any
+
+
+          # build request params
+          params = { :headers => user_agent_header }
+          params[:headers]['Content-Type'] = 'application/json'
+          params[:expects] = options[:expected] || [200,201]
+          params[:body] = Fog::JSON.encode({:parameters => [ options[:body] ]}) unless options[:body].nil?
+          params[:query] = options[:query] unless options[:query].nil?
+
+          # initialize connection object
+          @connection = Fog::Core::Connection.new(@request_url, false, params)
+
+          # send it
+          response = @connection.request(:method => http_method)
+
+          # decode it
+          response.body = Fog::JSON.decode(response.body)
+          response
+      end
+
+      private
+
+      def self.credentialize_url(username, apikey)
+        @request_url = "https://#{username}:#{apikey}@#{@request_url}"
+      end
+
+      ##
+      # Prepend "SoftLayer_" to the service name and Snake_Camel_Case the string before appending it to the @request_url.
+      #
+      def self.set_sl_service(service)
+        service = "SoftLayer_" << service.to_s.gsub(/^softlayer_/i, '').split('_').map{|i|i.capitalize}.join('_')
+        service.fix_convention_exceptions
+        @request_url += "/#{service}"
+      end
+
+      ##
+      # Try to smallCamelCase the path before appending it to the @request_url
+      #
+      def self.set_sl_path(path)
+        path = path.to_s.underscore.camelize
+        path.fix_convention_exceptions
+        @request_url += "/#{path}.json"
+      end
+
+      def self.user_agent_header
+        {"User-Agent" => "Fog SoftLayer Adapter #{Fog::Softlayer::VERSION}"}
+      end
+
+    end
+
+
+    extend Fog::Provider
     SL_API_URL = 'api.softlayer.com/rest/v3' unless defined? SL_API_URL
     SL_STORAGE_AUTH_URL = 'objectstorage.softlayer.net/auth/v1.0' unless defined? SL_STORAGE_AUTH_URL
 
     service(:compute, 'Compute')
     service(:dns, 'DNS')
+    service(:network, 'Network')
     service(:storage, 'Storage')
 
     def self.mock_account_id
@@ -49,6 +132,7 @@ module Fog
       obj
     end
   end
+
 end
 
 class Hash
@@ -57,3 +141,23 @@ class Hash
     self.merge(second, &merger)
   end
 end
+
+## some helpers for some dirty work
+class String
+  def camelize
+    self.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+  end
+
+  def fix_convention_exceptions
+    self.gsub!(/ipaddress/i, 'IpAddress') # SLAPI WHY U No Follow Own Convention!?
+  end
+
+  def underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+  end
+end
+

data/lib/fog/softlayer/models/compute/flavor.rb

@@ -4,6 +4,7 @@
 #
 # LICENSE: MIT (http://opensource.org/licenses/MIT)
 #
+
 require 'fog/core/model'
 
 module Fog

data/lib/fog/softlayer/models/compute/flavors.rb

@@ -4,6 +4,7 @@
 #
 # LICENSE: MIT (http://opensource.org/licenses/MIT)
 #
+
 require 'fog/core/collection'
 require 'fog/softlayer/models/compute/flavor'
 

data/lib/fog/softlayer/models/compute/image.rb

@@ -4,6 +4,7 @@
 #
 # LICENSE: MIT (http://opensource.org/licenses/MIT)
 #
+
 require 'fog/core/model'
 
 module Fog

data/lib/fog/softlayer/models/compute/images.rb

@@ -4,6 +4,7 @@
 #
 # LICENSE: MIT (http://opensource.org/licenses/MIT)
 #
+
 require 'fog/core/collection'
 require 'fog/softlayer/models/compute/image'
 

data/lib/fog/softlayer/models/compute/server.rb

@@ -4,6 +4,7 @@
 #
 # LICENSE: MIT (http://opensource.org/licenses/MIT)
 #
+
 require 'fog/compute/models/server'
 
 module Fog
@@ -43,6 +44,8 @@ module Fog
         attribute :tags,                    :aliases => 'tagReferences'
 
         def initialize(attributes = {})
+          # Forces every request inject bare_metal parameter
+          raise Exception if attributes[:collection].nil? and attributes['bare_metal'].nil?
           super(attributes)
           set_defaults
         end
@@ -60,18 +63,9 @@ module Fog
         def bare_metal?
           bare_metal
         end
-
-        def bare_metal=(set)
-          attributes[:bare_metal] = case set
-            when false, 'false', 0, nil, ''
-              0
-            else
-              1
-          end
-        end
-
+        
         def bare_metal
-          attributes[:bare_metal] === 1 ? true : false
+          @bare_metal
         end
 
         def datacenter=(name)
@@ -123,10 +117,40 @@ module Fog
         def pre_save
           extract_flavor
           validate_attributes
+          if self.vlan
+            attributes[:vlan] = { :networkVlan => { :id => self.vlan.id } }
+          end
+          if self.private_vlan
+            attributes[:private_vlan] = { :networkVlan => { :id => self.private_vlan.id } }
+          end
           remap_attributes(attributes, attributes_mapping)
           clean_attributes
         end
 
+        def vlan
+          attributes[:vlan] ||= _get_vlan
+        end
+
+        def private_vlan
+          attributes[:private_vlan] ||= _get_private_vlan
+        end
+
+        def vlan=(value)
+          unless value.is_a?(Integer) or value.is_a?(Fog::Network::Softlayer::Network)
+            raise ArgumentError, "vlan argument for #{self.class.name}##{__method__} must be Integer or Fog::Network::Softlayer::Network."
+          end
+          value = Fog::Network[:softlayer].networks.get(value) if value.is_a?(Integer)
+          attributes[:vlan] = value
+        end
+
+        def private_vlan=(value)
+          unless value.is_a?(Integer) or value.is_a?(Fog::Network::Softlayer::Network)
+            raise ArgumentError, "vlan argument for #{self.class.name}##{__method__} must be Integer or Fog::Network::Softlayer::Network."
+          end
+          value = Fog::Network[:softlayer].networks.get(value) if value.is_a?(Integer)
+          attributes[:private_vlan] = value
+        end
+
         def ram=(set)
           if set.is_a?(Array) and set.first['hardwareComponentModel']
             set = 1024 * set.first['hardwareComponentModel']['capacity'].to_i
@@ -198,6 +222,7 @@ module Fog
             service.create_vm(copy.attributes).body.first
           end
 
+          data.delete("bare_metal")
           merge_attributes(data)
           true
         end
@@ -208,12 +233,36 @@ module Fog
 
         private
 
+        def _get_private_vlan
+          if self.id
+            vlan_id = if bare_metal?
+              service.request(:hardware_server, "#{self.id}/get_private_vlan").body['id']
+            else
+              service.request(:virtual_guest, self.id, :query => 'objectMask=primaryBackendNetworkComponent.networkVlan').body['primaryBackendNetworkComponent']['networkVlan']['id']
+            end
+            Fog::Network[:softlayer].networks.get(vlan_id)
+          end
+        end
+
+        def _get_vlan
+          if self.id
+            vlan_id = if bare_metal?
+              service.request(:hardware_server, "#{self.id}/get_public_vlan").body['id']
+            else
+              service.request(:virtual_guest, self.id, :query => 'objectMask=primaryNetworkComponent.networkVlan').body['primaryNetworkComponent']['networkVlan']['id']
+            end
+            Fog::Network[:softlayer].networks.get(vlan_id)
+          end
+        end
+
         ##
         # Generate mapping for use with remap_attributes
         def attributes_mapping
           common = {
               :hourly_billing_flag => :hourlyBillingFlag,
               :os_code  =>  :operatingSystemReferenceCode,
+              :vlan => :primaryNetworkComponent,
+              :private_vlan => :primaryBackendNetworkComponent,
 
           }
 
@@ -236,10 +285,20 @@ module Fog
           common.merge(conditional)
         end
 
+        def bare_metal=(set)
+          raise Exception, "Bare metal flag has already been set" unless @bare_metal.nil?
+          @bare_metal = case set
+            when false, 'false', 0, nil, ''
+              false
+            else
+              true
+          end
+        end
+        
         ##
         # Remove model attributes that aren't expected by the SoftLayer API
         def clean_attributes
-          @bare_metal = attributes.delete(:bare_metal)
+          attributes.delete(:bare_metal)
           attributes.delete(:flavor_id)
           attributes.delete(:ephemeral_storage)
         end