ibm-cloud-sdk 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d147792b6e2fd5d7ddb2b243cb2993cb606289352883831c6b805c2489c1267b
-  data.tar.gz: e03cbb041d6aae300f09fa4b6fb1aaaed759b187645deb2e4eeca561307f4520
+  metadata.gz: 181a2894e2d8045bea0d2a33cf81570480eee1f668017b8ade96b1801d0465b2
+  data.tar.gz: 5399f7e3e4f4b483a72e673d351605cb1f8bb09f216e5fd1a9439742f736aedf
 SHA512:
-  metadata.gz: 920c4079d316f6d65dd4fb3b4d9bcb97d06d06b1165f43ba19b3b7c3f1e12dfe1063f2666fdaf26c2252e4fb9949363d804e4678c13f2676531993851da615d4
-  data.tar.gz: 125f277b64b64c751b5ae932df6d10203b7bbe01417f361667de8e36b942c574eb744e9432eebd3652ef2a21d0b5c34e05e936e3533a34c9f751d64d79bfeb0b
+  metadata.gz: 237fd30c5dd4efa622de5be57a2df9e2285dcabc3d15f415d6efb6bec31b36254cbaf6c3cb32a6d8b7113b7e8709e4eddee64736515030e5e3227694dc464b4e
+  data.tar.gz: ed36bdf032519bc35c1563f62fe279f6744b3f25b97fef4358ebd689958a48a17a5a1eafbf85f72a3c62e372dfb764b35463cc292eede788b3ad127170664ced

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
 
+## v0.1.4 - 2020-09-17
+- Added support for the IBM Virtual Private Cloud (VPC) service
+
 ## v0.1.3 - 2020-08-31
 ### Added the following rest api calls for Power System Virtual Server service 
 - Add PowerIaas 'delete_volume' method

data/ibm-cloud-sdk.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rest-client"
+  spec.add_dependency "http"
 end

data/lib/ibm/cloud/sdk.rb

@@ -1,3 +1,4 @@
+
 require "json"
 require "rest-client"
 
@@ -6,6 +7,7 @@ require "ibm/cloud/sdk/iam"
 require "ibm/cloud/sdk/power_iaas"
 require "ibm/cloud/sdk/resource_controller"
 require "ibm/cloud/sdk/version"
+require "ibm/cloud/sdk/vpc/cloud_sdk"
 
 module IBM
   module Cloud

data/lib/ibm/cloud/sdk/version.rb

@@ -1,7 +1,7 @@
 module IBM
   module Cloud
     module SDK
-      VERSION = "0.1.3"
+      VERSION = "0.1.4"
     end
   end
 end

data/lib/ibm/cloud/sdk/vpc.rb

@@ -0,0 +1,128 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'vpc/base_vpc'
+require_relative 'vpc/base_collection'
+require_relative 'vpc/base_instance'
+
+require_relative 'vpc/floatingips'
+require_relative 'vpc/flowlogcollectors'
+require_relative 'vpc/ike_policies'
+require_relative 'vpc/images'
+require_relative 'vpc/instances'
+require_relative 'vpc/ipsec_policies'
+require_relative 'vpc/keys'
+require_relative 'vpc/load_balancers'
+require_relative 'vpc/network_acls'
+require_relative 'vpc/operating_systems'
+require_relative 'vpc/public_gateways'
+require_relative 'vpc/regions'
+require_relative 'vpc/security_groups'
+require_relative 'vpc/subnets'
+require_relative 'vpc/volume_profiles'
+require_relative 'vpc/volumes'
+require_relative 'vpc/vpcs'
+require_relative 'vpc/vpn_gateways'
+
+module IBM
+  module Cloud
+    module SDK
+      # Container that encapsulates the VPC API.
+      class Vpc < BaseVPC
+        # Create an API Client object for the  VPC IaaS service
+        #
+        # @param region [String] the IBM Power Cloud instance region
+        # @param token [IAMtoken] the IBM Cloud IAM Token object
+        # @param logger [Logger] an instance of an instanciated logger.
+        def initialize(region, api_key, logger: nil)
+          @region = region
+          @api_key = api_key
+          @token = api_key
+
+          @logger = logger || Logger.new($stdout)
+        end
+
+        attr_reader :token, :logger
+        attr_accessor :region
+
+        # The Region API endpoint.
+        def endpoint
+          "https://#{region.sub(/-\d$/, '')}.iaas.cloud.ibm.com/v1"
+        end
+
+        # Entry point to the Floating IPs API.
+        def floating_ips
+          VPC::FloatingIPs.new(self)
+        end
+
+        def flowlog_collectors
+          VPC::FlowLogCollectors.new(self)
+        end
+
+        def ike_policies
+          VPC::IKEPolicies.new(self)
+        end
+
+        def images
+          VPC::Images.new(self)
+        end
+
+        def instances
+          VPC::Instances.new(self)
+        end
+
+        def ipsec_policies
+          VPC::IPSecPolicies.new(self)
+        end
+
+        def keys
+          VPC::Keys.new(self)
+        end
+
+        def load_balancers
+          VPC::LoadBalancers.new(self)
+        end
+
+        def network_acls
+          VPC::NetworkACLs.new(self)
+        end
+
+        def operating_systems
+          VPC::OperatingSystems.new(self)
+        end
+
+        def public_gateways
+          VPC::PublicGateways.new(self)
+        end
+
+        def regions
+          VPC::Regions.new(self)
+        end
+
+        def security_groups
+          VPC::SecurityGroups.new(self)
+        end
+
+        def subnets
+          VPC::Subnets.new(self)
+        end
+
+        def volumes_profiles
+          VPC::VolumeProfiles.new(self)
+        end
+
+        def volumes
+          VPC::Volumes.new(self)
+        end
+
+        def vpcs
+          VPC::Vpcs.new(self)
+        end
+
+        def vpn_gateways
+          VPC::VPNGateways.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/base_collection.rb

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      # Container that encapsulates the VPC API.
+      class BaseCollection < BaseVPC
+        def initialize(parent, endpoint, array_key: nil, child_class: nil)
+          # Setup empty base instance variables.
+          @data = nil
+          @params = nil
+
+          array_key ||= endpoint
+
+          # Set the array key and child class.
+          @array_key ||= array_key
+          @instance ||= child_class
+
+          super(parent, endpoint)
+        end
+
+        # Retrieve the collection from the cloud.
+        def fetch
+          @data ||= get(params: @params)
+          @data
+        end
+
+        def all
+          response = fetch.subkey(@array_key)
+          return response if response.is_a?(Array)
+
+          raise "#{self.class}.#{__method__} Expecting response to be an Array not a #{response.class}"
+        end
+
+        def params(start: nil, limit: nil, resource_group: nil)
+          @params = {}
+          @params['start'] = start if start
+          @params['limit'] = limit if limit
+          @params['resource_group'] = resource_group if resource_group
+          self
+        end
+
+        def count
+          fetch.subkey('total_count')
+        end
+
+        def limit
+          fetch.subkey('limit')
+        end
+
+        def instance(id)
+          @instance.new(self, id)
+        end
+
+        def next
+          fetch.subkey('next')
+        rescue RuntimeError
+          nil
+        end
+
+        def create(payload)
+          post(payload)
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/base_instance.rb

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      # Container that encapsulates the VPC API.
+      class BaseInstance < BaseVPC
+        def details
+          get.hash
+        end
+
+        def update(payload)
+          patch(payload)
+        end
+
+        def remove
+          delete
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/base_vpc.rb

@@ -0,0 +1,61 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      # Container that encapsulates the VPC API.
+      class BaseVPC
+        def initialize(parent, endpoint = nil)
+          @endpoint = parent.url(endpoint)
+          @token = parent.token
+          @logger = parent.logger
+        end
+
+        attr_reader :endpoint, :token, :logger
+
+        def adhoc(method: 'get', path: nil, params: {}, payload_type: 'json', payload: {})
+          @token.adhoc(method.to_sym, url(path), metadata(params, payload_type, payload))
+        end
+
+        def get(path: nil, params: {})
+          adhoc(method: 'get', path: path, params: params)
+        end
+
+        def post(payload = {}, path: nil, params: {}, type: 'json')
+          adhoc(method: 'post', path: path, params: params, payload: payload)
+        end
+
+        def put(payload = {}, path: nil, params: {})
+          adhoc(method: 'put', path: path, params: params, payload: payload)
+        end
+
+        def patch(payload = {},  path: nil, params: {})
+          adhoc(method: 'patch', path: path, params: params, payload: payload)
+        end
+
+        def delete(path: nil, params: {})
+          adhoc(method: 'delete', path: path, params: params)
+        end
+
+        def url(path = nil)
+          return endpoint unless path
+
+          "#{endpoint}/#{path}"
+        end
+
+        private
+
+        def metadata(params = {}, payload_type = 'json', payload = {})
+          params ||= {}
+          pt = {
+            params: { version: '2020-08-01', generation: 2 }.merge(params)
+          }
+
+          pt[payload_type.to_sym] = payload unless payload.empty?
+          pt
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/cloud_sdk.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'ibm/cloud/sdk/vpc/helpers/connection'
+require 'ibm/cloud/sdk/vpc'
+
+module IBM
+    # Holds the SDK pieces.
+    class CloudSDK
+      def initialize(api_key, logger: nil, options: {})
+        @logger = logger
+        @logger ||= Logger.new($stdout, level: :warn)
+
+        @client = HTTP.use(http_options(options))
+        @token = IBM::Cloud::SDK::VPC::Connection.new(api_key, logger: @logger, client: @client)
+      end
+
+      def http_options(options = {})
+        options.merge(
+          {
+            logging: { logger: @logger },
+            auto_deflate: {}
+          }
+        )
+      end
+
+      attr_reader :logger, :token
+
+      def vpc(region = 'us-east')
+        IBM::Cloud::SDK::Vpc.new(region, @token, logger: @logger)
+      end
+    end
+end

data/lib/ibm/cloud/sdk/vpc/floatingips.rb

@@ -0,0 +1,20 @@
+# typed: false
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # Class that deals with groups of floating IPs.
+        class FloatingIPs < BaseCollection
+          def initialize(parent)
+            super(parent, 'floating_ips', child_class: FloatingIP)
+          end
+        end
+
+        # Class that deals with a single floating IP.
+        class FloatingIP < BaseInstance; end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/flowlogcollectors.rb

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # A list of subnets
+        class FlowLogCollectors < BaseCollection
+          def initialize(parent)
+            super(parent, 'flow_log_collectors', child_class: FlowLogCollectors)
+          end
+        end
+
+        # A single subnet
+        class FlowLogCollector < BaseInstance; end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/helpers/connection.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'http'
+require_relative 'response'
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+
+        # Contols tokens.
+        class Connection
+          def initialize(api_key, logger: nil, client: nil)
+            @api_key = api_key
+            @logger = logger
+            @client = client
+            @token = Token.new(api_key, logger: logger, client: client)
+          end
+
+          attr_reader :client
+
+          def adhoc(verb, uri, opts = {})
+            response = @client.auth(@token.authorization_header).request(verb.to_sym, uri, opts)
+            Response.new(response)
+          end
+
+          def authorization_header
+            @token.authorization_header
+          end
+        end
+
+        # Get a token.
+        class Token
+          def initialize(api_key, logger: nil, client: nil)
+            @api_key = api_key
+            @logger = logger
+            @client = client
+            @data = fetch
+          end
+
+          def fetch
+            payload = {
+              form: {
+                grant_type: 'urn:ibm:params:oauth:grant-type:apikey',
+                apikey: @api_key
+              }
+            }
+            response = HTTP.post('https://iam.cloud.ibm.com/identity/token', payload)
+            @data = Response.new(response).json
+          end
+
+          def expired?
+            fetch unless @data
+            @data.fetch(:expiration).to_i <= Time.now.to_i + 600
+          end
+
+          def authorization_header
+            fetch if expired?
+            "#{@data.fetch(:token_type)} #{@data.fetch(:access_token)}"
+          end
+        end
+      end
+    end
+  end
+end