google-cloud-resource_manager 0.30.3 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15b1f5fe2a66250875ff2e25ad3c7c24c459b18b129b9010fd489774f8d4511
-  data.tar.gz: c304b85eabd473f1c9adeddb10cfca5bb9fc070d827a38218098f362302c9d19
+  metadata.gz: 4b2b524b149206b6776eb5dd65e24833d2bd1ff1643af4d37229bebc2bd42ecd
+  data.tar.gz: 4b8556c72c3182be9f3ba256786945d263c838c6b687b37a7dbe3731cd697e92
 SHA512:
-  metadata.gz: 7702f9223683a072c7fe99db3b067afe7c14d647634ed312103d6dea31e4f6328cb47724124f8825f93bda64d7d627df21721ead6d6547dd434e45d2c12ad4d8
-  data.tar.gz: 5eed5e29dfbfad2d3de78af0bd07d1dd8ac8ba60e4f96ed6ec3bb7e25c813c242d023536416cb02aed11ce51030ddb4a252a57178e6420c3792de72e2e706265
+  metadata.gz: 3ef341093f4fd54a886d916c528ef32091f259feb2778861cb60459d14c6f2ca920002b96a2eb49def80a15dc24a3fe1d48fc2d4d8ea347fef57e148cd8a7e15
+  data.tar.gz: 4e66a0d717be7f176b3b807b9ec30e74875efb06a525c726dd832fc09a44a494406f2eb3ef95ce6677d18253aa0233ca3a7396bde59c245edad67f73cf61cb8b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### 0.31.0 / 2019-02-12
+
+* Add parent resoure to `Project`:
+  * Add `Project#parent`.
+  * Add `parent` optional named argument to `Manager#create_project`.
+  * Add `Resource` class.
+  * Add `Manager#resource` convenience method.
+
 ### 0.30.3 / 2018-09-20
 
 * Update documentation.

data/lib/google/cloud/resource_manager/manager.rb

@@ -17,6 +17,7 @@ require "google/cloud/errors"
 require "google/cloud/resource_manager/credentials"
 require "google/cloud/resource_manager/service"
 require "google/cloud/resource_manager/project"
+require "google/cloud/resource_manager/resource"
 
 module Google
   module Cloud
@@ -166,6 +167,15 @@ module Google
         #   <code>([a-z]([-a-z0-9]*[a-z0-9])?)?</code>.
         #
         #   No more than 256 labels can be associated with a given resource.
+        # @param [Resource] parent A parent Resource. Optional.
+        #
+        #   Supported parent types include "organization" and "folder". Once
+        #   set, the parent can be updated but cannot be cleared.
+        #
+        #   The end user must have the `resourcemanager.projects.create`
+        #   permission on the parent.
+        #
+        #   (See {#resource} and {Resource}.)
         #
         # @return [Google::Cloud::ResourceManager::Project]
         #
@@ -182,8 +192,16 @@ module Google
         #   project = resource_manager.create_project "tokyo-rain-123",
         #     name: "Todos Development", labels: {env: :development}
         #
-        def create_project project_id, name: nil, labels: nil
-          gapi = service.create_project project_id, name, labels
+        # @example A project can also be created with a `name` and `parent`:
+        #   require "google/cloud/resource_manager"
+        #
+        #   resource_manager = Google::Cloud::ResourceManager.new
+        #   folder = resource_manager.resource "folder", "1234"
+        #   project = resource_manager.create_project "tokyo-rain-123",
+        #     name: "Todos Development", parent: folder
+        #
+        def create_project project_id, name: nil, labels: nil, parent: nil
+          gapi = service.create_project project_id, name, labels, parent
           Project.from_gapi gapi, service
         end
 
@@ -241,6 +259,27 @@ module Google
           true
         end
 
+        ##
+        # Create a Resource object. (See {Resource}.)
+        #
+        # @param [String] type The resource type this id is for. At present, the
+        #   valid types are: "organization" and "folder".
+        # @param [String] id The type-specific id. This should correspond to the
+        #   id used in the type-specific API's.
+        # @return [resource]
+        #
+        # @example
+        #   require "google/cloud/resource_manager"
+        #
+        #   resource_manager = Google::Cloud::ResourceManager.new
+        #   project = resource_manager.project "tokyo-rain-123"
+        #   folder = resource_manager.resource "folder", "1234"
+        #   project.parent = folder
+        #
+        def resource type, id
+          Resource.new type, id
+        end
+
         protected
 
         ##

data/lib/google/cloud/resource_manager/project.rb

@@ -17,6 +17,7 @@ require "time"
 require "google/cloud/resource_manager/project/list"
 require "google/cloud/resource_manager/project/updater"
 require "google/cloud/resource_manager/policy"
+require "google/cloud/resource_manager/resource"
 
 module Google
   module Cloud
@@ -164,6 +165,51 @@ module Google
           @gapi = service.update_project @gapi
         end
 
+        ##
+        # An optional reference to a parent Resource.
+        #
+        # Supported parent types include "organization" and "folder". Once set,
+        # the parent can be updated but cannot be cleared.
+        #
+        # The resource object returned is read-only and cannot be changed. A new
+        # resource object can be set using the `#parent=` or `#update` methods.
+        # (See {Resource} and {Manager#resource}.)
+        #
+        # @return [nil, Resource] the reference to a parent Resource (read-only)
+        #
+        def parent
+          return nil if @gapi.parent.nil?
+          Resource.from_gapi(@gapi.parent).freeze
+        end
+
+        ##
+        # Updates the reference to a parent with a new Resource.
+        #
+        # Supported parent types include "organization" and "folder". Once set,
+        # the parent can be updated but cannot be cleared.
+        #
+        # The end user must have the `resourcemanager.projects.create`
+        # permission on the parent.
+        #
+        # (See {Resource} and {Manager#resource}.)
+        #
+        # @param [Resource] new_parent A new parent Resource.
+        #
+        # @example
+        #   require "google/cloud/resource_manager"
+        #
+        #   resource_manager = Google::Cloud::ResourceManager.new
+        #   project = resource_manager.project "tokyo-rain-123"
+        #   folder = resource_manager.resource "folder", "1234"
+        #   project.parent = folder
+        #
+        def parent= new_parent
+          raise ArgumentError, "new_parent is required" if new_parent.nil?
+          ensure_service!
+          @gapi.parent = new_parent.to_gapi
+          @gapi = service.update_project @gapi
+        end
+
         ##
         # The time that this project was created.
         #
@@ -230,8 +276,10 @@ module Google
         #
         #   resource_manager = Google::Cloud::ResourceManager.new
         #   project = resource_manager.project "tokyo-rain-123"
+        #   folder = resource_manager.resource "folder", "1234"
         #   project.update do |p|
         #     p.name = "My Project"
+        #     p.parent = folder
         #     p.labels["env"] = "production"
         #   end
         #

data/lib/google/cloud/resource_manager/project/updater.rb

@@ -117,6 +117,32 @@ module Google
             gapi.labels = new_labels
           end
 
+          ##
+          # Updates the reference to a parent with a new Resource.
+          #
+          # Supported parent types include "organization" and "folder". Once
+          # set, the parent can be updated but cannot be cleared.
+          #
+          # The end user must have the `resourcemanager.projects.create`
+          # permission on the parent.
+          #
+          # (See {Resource} and {Manager#resource}.)
+          #
+          # @param [Resource] new_parent A new parent Resource.
+          #
+          # @example
+          #   require "google/cloud/resource_manager"
+          #
+          #   resource_manager = Google::Cloud::ResourceManager.new
+          #   project = resource_manager.project "tokyo-rain-123"
+          #   folder = resource_manager.resource "folder", "1234"
+          #   project.parent = folder
+          #
+          def parent= new_parent
+            raise ArgumentError, "new_parent is required" if new_parent.nil?
+            gapi.parent = new_parent.to_gapi
+          end
+
           ##
           # @private Create an Updater object.
           def self.from_project project

data/lib/google/cloud/resource_manager/resource.rb

@@ -0,0 +1,119 @@
+# Copyright 2019 Google LLC
+#
+# 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
+#
+#     https://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.
+
+
+module Google
+  module Cloud
+    module ResourceManager
+      ##
+      # # Resource
+      #
+      # A container to reference an id for any resource type. A `resource` in
+      # Google Cloud Platform is a generic term for something a developer may
+      # want to interact with through an API. Some examples are an App Engine
+      # app, a Compute Engine instance, a Cloud SQL database, and so on. (See
+      # {Manager#resource}.)
+      #
+      # @example
+      #   require "google/cloud/resource_manager"
+      #
+      #   resource_manager = Google::Cloud::ResourceManager.new
+      #   project = resource_manager.project "tokyo-rain-123"
+      #   folder = Google::Cloud::ResourceManager::Resource.new "folder", "1234"
+      #   project.parent = folder
+      #
+      class Resource
+        ##
+        # Create a Resource object.
+        #
+        # @param [String] type The resource type this id is for. At present, the
+        #   valid types are: "organization" and "folder".
+        # @param [String] id The type-specific id. This should correspond to the
+        #   id used in the type-specific API's.
+        def initialize type, id
+          raise ArgumentError, "type is required" if type.nil?
+          raise ArgumentError, "id is required"   if id.nil?
+
+          @type = type
+          @id   = id
+        end
+
+        ##
+        # Required field representing the resource type this id is for. At
+        # present, the valid types are: "organization" and "folder".
+        # @return [String]
+        attr_accessor :type
+
+        ##
+        # Required field for the type-specific id. This should correspond to the
+        # id used in the type-specific API's.
+        # @return [String]
+        attr_accessor :id
+
+        ##
+        # Checks if the type is `folder`.
+        # @return [Boolean]
+        def folder?
+          return false if type.nil?
+          "folder".casecmp(type).zero?
+        end
+
+        ##
+        # Checks if the type is `organization`.
+        # @return [Boolean]
+        def organization?
+          return false if type.nil?
+          "organization".casecmp(type).zero?
+        end
+
+        ##
+        # Create a Resource object with type `folder`.
+        #
+        # @param [String] id The type-specific id. This should correspond to the
+        #   id used in the type-specific API's.
+        # @return [Resource]
+        def self.folder id
+          new "folder", id
+        end
+
+        ##
+        # Create a Resource object with type `organization`.
+        #
+        # @param [String] id The type-specific id. This should correspond to the
+        #   id used in the type-specific API's.
+        # @return [Resource]
+        def self.organization id
+          new "organization", id
+        end
+
+        ##
+        # @private Convert the Resource to a Google API Client ResourceId
+        # object.
+        def to_gapi
+          Google::Apis::CloudresourcemanagerV1::ResourceId.new(
+            type: type,
+            id: id
+          )
+        end
+
+        ##
+        # @private Create new Resource from a Google API Client ResourceId
+        # object.
+        def self.from_gapi gapi
+          new gapi.type, gapi.id
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/resource_manager/service.rb

@@ -74,9 +74,11 @@ module Google
 
         ##
         # Returns API::Project
-        def create_project project_id, name, labels
-          project_attrs = { project_id: project_id, name: name,
-                            labels: labels }.delete_if { |_, v| v.nil? }
+        def create_project project_id, name, labels, parent
+          parent = parent.to_gapi unless parent.nil?
+          project_attrs = {
+            project_id: project_id, name: name, labels: labels, parent: parent
+          }.delete_if { |_, v| v.nil? }
           execute { service.create_project API::Project.new(project_attrs) }
         end
 

data/lib/google/cloud/resource_manager/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module ResourceManager
-      VERSION = "0.30.3".freeze
+      VERSION = "0.31.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-resource_manager
 version: !ruby/object:Gem::Version
-  version: 0.30.3
+  version: 0.31.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -43,16 +43,22 @@ dependencies:
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +149,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.61.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +225,7 @@ files:
 - lib/google/cloud/resource_manager/project.rb
 - lib/google/cloud/resource_manager/project/list.rb
 - lib/google/cloud/resource_manager/project/updater.rb
+- lib/google/cloud/resource_manager/resource.rb
 - lib/google/cloud/resource_manager/service.rb
 - lib/google/cloud/resource_manager/version.rb
 homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-resource_manager
@@ -241,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Resource Manager