ibm-cloud-sdk 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20e66e3c2588ddaf738a31e2f6c7e4f04b1664c4bbeb8c3819515b5df0b0bf4a
-  data.tar.gz: 7f2921c6b950773077d71ce80f8ed6dc68fedcb583df4b6d63467177b40a15be
+  metadata.gz: 8fe8cad325a98aabb1bd328c04aec7c1c4b7dbda4859d41a85baa51916a40d80
+  data.tar.gz: e40564d9e168b80623282caa7bb1b4efe5519e16a7757f8ac657ddbf57c0976a
 SHA512:
-  metadata.gz: 5fb192e3f61c316392ba61cca0583ec2838ae7e909e2a544eb7572672a527797b3c442b077f8f7ac5124469db36e22a79cfe6fd25d30855a8697620d2beffc0f
-  data.tar.gz: 4ff41931a8647133664a7ba9842b8858bd2920736a94472cf227fb9d229336b18e3c26a1d8b0fe9ce7616b6f88f052a00a809befd5e821415e1bac64a94ab928
+  metadata.gz: 2dabd16a4f84e7c7ade80f0a5d36f0796f15681a53f0f271b01ff6d98b41b00ea249f681c9c402961e53c0a94943c32c18d41e6f1421075be15561ce5c369c7e
+  data.tar.gz: 90bea5c5ae247170955e937be0fef41c8bd43f0d8749b8a3c08786f25759dd669e5f32e9a35bedada529a5936eb9ae0f06a329df4dcbb99a56c60d2f4dbb7659

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
+
+## v0.1.5 - 2020-09-21
+- Added Enumerable based pagination support
+- Move instance profiles
+- Improve resource lookup by GUID
+- Add support to create a PowerIaas volume
+
+## 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
+- Add PowerVS SAP API calls
+- get list of available system pools within a particular data center
+- get list of all storage type availble in the data center. There may be 
+  update to the call once PowerVS service updates the storage type rest api 
+  for Power System Virtual Server service . 
+

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -28,5 +28,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ibm-cloud-sdk.
+Bug reports and pull requests are welcome on GitHub at https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby.
 

data/ibm-cloud-sdk.gemspec

@@ -8,9 +8,11 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{IBM Cloud API Ruby gem.}
   spec.description   = %q{A Ruby gem for interacting with the various IBM Cloud services.}
   spec.homepage      = "https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby"
+  spec.licenses      = %w["Apache-2.0"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["homepage_uri"]  = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/v#{spec.version}/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -22,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/power_iaas.rb

@@ -18,7 +18,7 @@ module IBM
         end
 
         def endpoint
-          "https://#{region}.power-iaas.cloud.ibm.com/pcloud/v1"
+          "https://#{region.sub(/-\d$/, '')}.power-iaas.cloud.ibm.com/pcloud/v1"
         end
 
         # Get all PVM instances in an IBM Power Cloud instance
@@ -113,6 +113,21 @@ module IBM
           get("cloud-instances/#{guid}/volumes/#{volume_id}")
         end
 
+        # Delete a volume
+        #
+        # @param volume_id [String] The ID of a volume
+        def delete_volume(volume_id)
+          delete("cloud-instances/#{guid}/volumes/#{volume_id}")
+        end
+
+        # Create a volume
+        #
+        # @param volume_hash [Hash] New volume attributes
+        # @return [Hash] Volume
+        def create_volume(volume_hash)
+          post("cloud-instances/#{guid}/volumes", volume_hash.to_json)
+        end
+
         # Get all networks in an IBM Power Cloud instance
         #
         # @return [Array<Hash>] all networks for this IBM Power Cloud instance
@@ -131,6 +146,22 @@ module IBM
           get("cloud-instances/#{guid}/networks/#{network_id}")
         end
 
+        # Get a available system pools list for IBM Power Cloud DC
+        #
+        # @return [Hash] SystemPool
+        def get_system_pool
+          get("cloud-instances/#{guid}/system-pools")
+        end
+
+        # Get a storage types list in IBM  Power Cloud.
+        # note: this mehod to be refactored under the common 
+        # IBM::Cloud::SDK::PowerIaas.endpoint when the rest api become available.
+        #
+        # @return [Hash] StorageType
+        def get_storage_types
+          JSON.parse(RestClient.get("https://#{region.sub(/-\d$/, '')}.power-iaas.cloud.ibm.com/broker/v1/storage-types", headers))
+        end
+
         def create_network(network_hash)
           post("cloud-instances/#{guid}/networks", network_hash.to_json)
         end
@@ -156,6 +187,37 @@ module IBM
           delete("tenants/#{tenant}/sshkeys/#{name}")
         end
 
+        # Get an SAP profile
+        #
+        # @param sap_profile_id [String] The ID of an SAP profile
+        # @return [Hash] SAP profile
+        def get_sap_profile(sap_profile_id)
+          get("cloud-instances/#{guid}/sap/#{sap_profile_id}")
+        end
+
+        # Get list of all SAP profiles
+        #
+        # @return [Array<Hash>] all SAP profiles available to this instance
+        def get_sap_profiles
+          sap_profiles = get("cloud-instances/#{guid}/sap")["profiles"] || []
+
+          sap_profiles.map do |sap_profile|
+            get_sap_profile(sap_profile["profileID"])
+          end
+        end
+
+        # Create a new SAP PVM Instance
+        #
+        # Create a new PVM instance using an SAP profile. The resultant PVM
+        # instance is the standard 'PVMInstance' type and can be accessed via
+        # the existing *_pvm_instance methods.
+        #
+        # @param sap_profile_id [String] The ID of an SAP profile
+        # @return [Hash] SAP profile
+        def create_sap_pvm_instance(instance_hash)
+          post("cloud-instances/#{guid}/sap", instance_hash.to_json)
+        end
+
         private
 
         attr_reader :crn, :guid, :region, :tenant, :token

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

@@ -2,6 +2,7 @@ module IBM
   module Cloud
     module SDK
       class ResourceController < BaseService
+        require "ibm/cloud/sdk/resource_controller/resource"
         def endpoint
           "https://resource-controller.cloud.ibm.com/v2"
         end
@@ -10,15 +11,8 @@ module IBM
           @token = token
         end
 
-        def get_resources
-          resources = get("resource_instances")["resources"] || []
-
-          require "ibm/cloud/sdk/resource_controller/resource"
-          resources.map { |instance| Resource.new(instance) }
-        end
-
         def get_resource(guid)
-          get_resources.detect { |resource| resource.guid == guid }
+          Resource.new(get("resource_instances/#{guid}"))
         end
 
         private

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

@@ -1,7 +1,7 @@
 module IBM
   module Cloud
     module SDK
-      VERSION = "0.1.0"
+      VERSION = "0.1.5"
     end
   end
 end

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

@@ -0,0 +1,132 @@
+# 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/instance_profiles'
+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 connection [IBM::Cloud::SDK::VPC::Connection] A connection object.
+        # @param logger [Logger] An instance of an instanciated logger.
+        def initialize(region, connection, logger: nil)
+          @region = region
+          @connection = connection
+
+          @logger = logger || Logger.new($stdout, level: :warn)
+        end
+
+        attr_reader :connection, :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 instance_profiles
+          VPC::InstanceProfiles.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