google-cloud-resource_manager 0.39.0 → 1.0.0

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

@@ -1,300 +0,0 @@
-# Copyright 2015 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.
-
-
-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
-    module ResourceManager
-      ##
-      # # Manager
-      #
-      # Provides methods for creating, retrieving, and updating projects.
-      #
-      # @example
-      #   require "google/cloud/resource_manager"
-      #
-      #   resource_manager = Google::Cloud::ResourceManager.new
-      #   resource_manager.projects.each do |project|
-      #     puts projects.project_id
-      #   end
-      #
-      # See {Google::Cloud#resource_manager}
-      class Manager
-        ##
-        # @private The Service object.
-        attr_accessor :service
-
-        ##
-        # @private Creates a new Service instance.
-        #
-        # See {Google::Cloud.resource_manager}
-        def initialize service
-          @service = service
-        end
-
-        ##
-        # Retrieves the projects that are visible to the user and satisfy the
-        # specified filter. This method returns projects in an unspecified
-        # order. New projects do not necessarily appear at the end of the list.
-        #
-        # @param [String] filter An expression for filtering the results of the
-        #   request. Filter rules are case insensitive.
-        #
-        #   The fields eligible for filtering are:
-        #
-        #   * `name`
-        #   * `id`
-        #   * `labels.key` - where `key` is the name of a label
-        #
-        #   Some examples of using labels as filters:
-        #
-        #   * `name:*` - The project has a name.
-        #   * `name:Howl` - The project's name is Howl or howl.
-        #   * `name:HOWL` - Equivalent to above.
-        #   * `NAME:howl` - Equivalent to above.
-        #   * `labels.color:*` - The project has the label color.
-        #   * `labels.color:red` - The project's label color has the value red.
-        #   * `labels.color:red labels.size:big` - The project's
-        #     label color has the value red and its label size has the value
-        #     big.
-        # @param [String] token A previously-returned page token representing
-        #   part of the larger set of results to view.
-        # @param [Integer] max Maximum number of projects to return.
-        #
-        # @return [Array<Google::Cloud::ResourceManager::Project>] (See
-        #   {Google::Cloud::ResourceManager::Project::List})
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   projects = resource_manager.projects
-        #
-        #   projects.each do |project|
-        #     puts project.project_id
-        #   end
-        #
-        # @example Projects can be filtered using the `filter` option:
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   projects = resource_manager.projects filter: "labels.env:production"
-        #
-        #   projects.each do |project|
-        #     puts project.project_id
-        #   end
-        #
-        # @example Retrieve all projects: (See {Project::List#all})
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   projects = resource_manager.projects
-        #
-        #   projects.all do |project|
-        #     puts project.project_id
-        #   end
-        #
-        def projects filter: nil, token: nil, max: nil
-          gapi = service.list_project filter: filter, token: token, max: max
-          Project::List.from_gapi gapi, self, filter, max
-        end
-
-        ##
-        # Retrieves the project identified by the specified `project_id`.
-        #
-        # @param [String] project_id The ID of the project.
-        #
-        # @return [Google::Cloud::ResourceManager::Project, nil] Returns `nil`
-        #   if the project does not exist
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   project = resource_manager.project "tokyo-rain-123"
-        #   project.project_id #=> "tokyo-rain-123"
-        #
-        def project project_id
-          gapi = service.get_project project_id
-          Project.from_gapi gapi, service
-        rescue NotFoundError
-          nil
-        end
-
-        ##
-        # Creates a project resource.
-        #
-        # Initially, the project resource is owned by its creator exclusively.
-        # The creator can later grant permission to others to read or update the
-        # project.
-        #
-        # Several APIs are activated automatically for the project, including
-        # Google Cloud Storage.
-        #
-        # @param [String] project_id The unique, user-assigned ID of the
-        #   project. It must be 6 to 30 lowercase letters, digits, or hyphens.
-        #   It must start with a letter. Trailing hyphens are prohibited.
-        # @param [String] name The user-assigned name of the project. This field
-        #   is optional and can remain unset.
-        #
-        #   Allowed characters are: lowercase and uppercase letters, numbers,
-        #   hyphen, single-quote, double-quote, space, and exclamation point.
-        # @param [Hash] labels The labels associated with this project.
-        #
-        #   Label keys must be between 1 and 63 characters long and must conform
-        #   to the following regular expression:
-        #   `[a-z]([-a-z0-9]*[a-z0-9])?`.
-        #
-        #   Label values must be between 0 and 63 characters long and must
-        #   conform to the regular expression
-        #   `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
-        #
-        #   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]
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   project = resource_manager.create_project "tokyo-rain-123"
-        #
-        # @example A project can also be created with a `name` and `labels`:
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   project = resource_manager.create_project "tokyo-rain-123",
-        #     name: "Todos Development", labels: {env: :development}
-        #
-        # @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
-
-        ##
-        # Marks the project for deletion. This method will only affect the
-        # project if the following criteria are met:
-        #
-        # * The project does not have a billing account associated with it.
-        # * The project has a lifecycle state of `ACTIVE`.
-        # * This method changes the project's lifecycle state from `ACTIVE` to
-        #   `DELETE_REQUESTED`. The deletion starts at an unspecified time, at
-        #   which point the lifecycle state changes to `DELETE_IN_PROGRESS`.
-        #
-        # Until the deletion completes, you can check the lifecycle state by
-        # retrieving the project with Manager#project. The project remains
-        # visible to Manager#project and Manager#projects, but cannot be
-        # updated.
-        #
-        # After the deletion completes, the project is not retrievable by the
-        # Manager#project and Manager#projects methods.
-        #
-        # The caller must have modify permissions for this project.
-        #
-        # @param [String] project_id The ID of the project.
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   resource_manager.delete "tokyo-rain-123"
-        #
-        def delete project_id
-          service.delete_project project_id
-          true
-        end
-
-        ##
-        # Restores the project. You can only use this method for a project that
-        # has a lifecycle state of `DELETE_REQUESTED`. After deletion starts, as
-        # indicated by a lifecycle state of `DELETE_IN_PROGRESS`, the project
-        # cannot be restored.
-        #
-        # The caller must have modify permissions for this project.
-        #
-        # @param [String] project_id The ID of the project.
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   resource_manager.undelete "tokyo-rain-123"
-        #
-        def undelete project_id
-          service.undelete_project project_id
-          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
-
-        ##
-        # Create an options hash from the projects parameters.
-        def list_projects_options filter, options
-          # Handle only sending in options
-          if filter.is_a?(::Hash) && options.empty?
-            options = filter
-            filter = nil
-          end
-          # Give named parameter priority
-          options[:filter] = filter || options[:filter]
-          options
-        end
-      end
-    end
-  end
-end

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

@@ -1,191 +0,0 @@
-# Copyright 2016 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.
-
-
-require "google/cloud/errors"
-require "google/apis/cloudresourcemanager_v1"
-
-module Google
-  module Cloud
-    module ResourceManager
-      ##
-      # # Policy
-      #
-      # Represents a Cloud IAM Policy for the Resource Manager service.
-      #
-      # A common pattern for updating a resource's metadata, such as its Policy,
-      # is to read the current data from the service, update the data locally,
-      # and then send the modified data for writing. This pattern may result in
-      # a conflict if two or more processes attempt the sequence simultaneously.
-      # IAM solves this problem with the
-      # {Google::Cloud::ResourceManager::Policy#etag} property, which is used to
-      # verify whether the policy has changed since the last request. When you
-      # make a request to with an `etag` value, Cloud IAM compares the `etag`
-      # value in the request with the existing `etag` value associated with the
-      # policy. It writes the policy only if the `etag` values match.
-      #
-      # When you update a policy, first read the policy (and its current `etag`)
-      # from the service, then modify the policy locally, and then write the
-      # modified policy to the service. See
-      # {Google::Cloud::ResourceManager::Project#policy} and
-      # {Google::Cloud::ResourceManager::Project#policy=}.
-      #
-      # @see https://cloud.google.com/iam/docs/managing-policies Managing
-      #   policies
-      # @see https://cloud.google.com/resource-manager/reference/rest/v1beta1/projects/setIamPolicy
-      #   projects.setIamPolicy
-      #
-      # @attr [String] etag Used to verify whether the policy has changed since
-      #   the last request. The policy will be written only if the `etag` values
-      #   match.
-      # @attr [Hash{String => Array<String>}] roles The bindings that associate
-      #   roles with an array of members. See [Understanding
-      #   Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-      #   listing of primitive and curated roles. See
-      #   [Binding](https://cloud.google.com/resource-manager/reference/rest/Shared.Types/Binding)
-      #   for a listing of values and patterns for members.
-      #
-      # @example
-      #   require "google/cloud/resource_manager"
-      #
-      #   resource_manager = Google::Cloud::ResourceManager.new
-      #   project = resource_manager.project "tokyo-rain-123"
-      #
-      #   project.policy do |p|
-      #     p.remove "roles/owner", "user:owner@example.com"
-      #     p.add "roles/owner", "user:newowner@example.com"
-      #     p.roles["roles/viewer"] = ["allUsers"]
-      #   end
-      #
-      class Policy
-        ##
-        # Alias to the Google Client API module
-        API = Google::Apis::CloudresourcemanagerV1
-
-        attr_reader :etag
-        attr_reader :roles
-
-        ##
-        # @private Creates a Policy object.
-        def initialize etag, roles
-          @etag = etag
-          @roles = roles
-        end
-
-        ##
-        # Convenience method for adding a member to a binding on this policy.
-        # See [Understanding
-        # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-        # listing of primitive and curated roles. See
-        # [Binding](https://cloud.google.com/resource-manager/reference/rest/Shared.Types/Binding)
-        # for a listing of values and patterns for members.
-        #
-        # @param [String] role_name A Cloud IAM role, such as `"roles/owner"`.
-        # @param [String] member A Cloud IAM identity, such as
-        #   `"user:owner@example.com"`.
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   project = resource_manager.project "tokyo-rain-123"
-        #
-        #   project.policy do |p|
-        #     p.add "roles/owner", "user:newowner@example.com"
-        #   end
-        #
-        def add role_name, member
-          role(role_name) << member
-        end
-
-        ##
-        # Convenience method for removing a member from a binding on this
-        # policy. See [Understanding
-        # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-        # listing of primitive and curated roles. See
-        # [Binding](https://cloud.google.com/resource-manager/reference/rest/Shared.Types/Binding)
-        # for a listing of values and patterns for members.
-        #
-        # @param [String] role_name A Cloud IAM role, such as `"roles/owner"`.
-        # @param [String] member A Cloud IAM identity, such as
-        #   `"user:owner@example.com"`.
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   project = resource_manager.project "tokyo-rain-123"
-        #
-        #   project.policy do |p|
-        #     p.remove "roles/owner", "user:owner@example.com"
-        #   end
-        #
-        def remove role_name, member
-          role(role_name).delete member
-        end
-
-        ##
-        # Convenience method returning the array of members bound to a role in
-        # this policy, or an empty array if no value is present for the role in
-        # {#roles}. See [Understanding
-        # Roles](https://cloud.google.com/iam/docs/understanding-roles) for a
-        # listing of primitive and curated roles. See
-        # [Binding](https://cloud.google.com/resource-manager/reference/rest/Shared.Types/Binding)
-        # for a listing of values and patterns for members.
-        #
-        # @return [Array<String>] The members strings, or an empty array.
-        #
-        # @example
-        #   require "google/cloud/resource_manager"
-        #
-        #   resource_manager = Google::Cloud::ResourceManager.new
-        #   project = resource_manager.project "tokyo-rain-123"
-        #
-        #   project.policy do |p|
-        #     p.role("roles/viewer") << "user:viewer@example.com"
-        #   end
-        #
-        def role role_name
-          roles[role_name] ||= []
-        end
-
-        ##
-        # @private Convert the Policy to a
-        # Google::Apis::CloudresourcemanagerV1::Policy.
-        def to_gapi
-          API::Policy.new(
-            etag: etag,
-            bindings: roles.keys.map do |role_name|
-              next if roles[role_name].empty?
-              API::Binding.new(
-                role: role_name,
-                members: roles[role_name].uniq
-              )
-            end
-          )
-        end
-
-        ##
-        # @private New Policy from a
-        # Google::Apis::CloudresourcemanagerV1::Policy object.
-        def self.from_gapi gapi
-          roles = Array(gapi.bindings).each_with_object({}) do |binding, memo|
-            memo[binding.role] = binding.members.to_a
-          end
-          new gapi.etag, roles
-        end
-      end
-    end
-  end
-end

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

@@ -1,166 +0,0 @@
-# Copyright 2015 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.
-
-
-require "delegate"
-
-module Google
-  module Cloud
-    module ResourceManager
-      class Project
-        ##
-        # Project::List is a special case Array with additional values.
-        class List < DelegateClass(::Array)
-          ##
-          # If not empty, indicates that there are more projects that match
-          # the request and this value should be passed to continue.
-          attr_accessor :token
-
-          ##
-          # @private Create a new Project::List with an array of Project
-          # instances.
-          def initialize arr = []
-            super arr
-          end
-
-          ##
-          # Whether there is a next page of projects.
-          #
-          # @return [Boolean]
-          #
-          # @example
-          #   require "google/cloud/resource_manager"
-          #
-          #   resource_manager = Google::Cloud::ResourceManager.new
-          #
-          #   projects = resource_manager.projects
-          #   if projects.next?
-          #     next_projects = projects.next
-          #   end
-          #
-          def next?
-            !token.nil?
-          end
-
-          ##
-          # Retrieve the next page of projects.
-          #
-          # @return [Project::List]
-          #
-          # @example
-          #   require "google/cloud/resource_manager"
-          #
-          #   resource_manager = Google::Cloud::ResourceManager.new
-          #
-          #   projects = resource_manager.projects
-          #   if projects.next?
-          #     next_projects = projects.next
-          #   end
-          #
-          def next
-            return nil unless next?
-            ensure_manager!
-            @manager.projects token: token, filter: @filter, max: @max
-          end
-
-          ##
-          # Retrieves remaining results by repeatedly invoking {#next} until
-          # {#next?} returns `false`. Calls the given block once for each
-          # result, which is passed as the argument to the block.
-          #
-          # An Enumerator is returned if no block is given.
-          #
-          # This method will make repeated API calls until all remaining results
-          # are retrieved. (Unlike `#each`, for example, which merely iterates
-          # over the results returned by a single API call.) Use with caution.
-          #
-          # @param [Integer] request_limit The upper limit of API requests to
-          #   make to load all projects. Default is no limit.
-          # @yield [project] The block for accessing each project.
-          # @yieldparam [Project] project The project object.
-          #
-          # @return [Enumerator]
-          #
-          # @example Iterating each project by passing a block:
-          #   require "google/cloud/resource_manager"
-          #
-          #   resource_manager = Google::Cloud::ResourceManager.new
-          #   projects = resource_manager.projects
-          #
-          #   projects.all do |project|
-          #     puts project.project_id
-          #   end
-          #
-          # @example Using the enumerator by not passing a block:
-          #   require "google/cloud/resource_manager"
-          #
-          #   resource_manager = Google::Cloud::ResourceManager.new
-          #   projects = resource_manager.projects
-          #
-          #   all_project_ids = projects.all.map do |project|
-          #     project.project_id
-          #   end
-          #
-          # @example Limit the number of API calls made:
-          #   require "google/cloud/resource_manager"
-          #
-          #   resource_manager = Google::Cloud::ResourceManager.new
-          #   projects = resource_manager.projects
-          #
-          #   projects.all(request_limit: 10) do |project|
-          #     puts project.project_id
-          #   end
-          #
-          def all request_limit: nil, &block
-            request_limit = request_limit.to_i if request_limit
-            unless block_given?
-              return enum_for :all, request_limit: request_limit
-            end
-            results = self
-            loop do
-              results.each(&block)
-              if request_limit
-                request_limit -= 1
-                break if request_limit.negative?
-              end
-              break unless results.next?
-              results = results.next
-            end
-          end
-
-          ##
-          # @private New Projects::List from a response object.
-          def self.from_gapi gapi_list, manager, filter = nil, max = nil
-            projects = new(Array(gapi_list.projects).map do |gapi_object|
-              Project.from_gapi gapi_object, manager.service
-            end)
-            projects.instance_variable_set :@token,   gapi_list.next_page_token
-            projects.instance_variable_set :@manager, manager
-            projects.instance_variable_set :@filter,  filter
-            projects.instance_variable_set :@max,     max
-            projects
-          end
-
-          protected
-
-          ##
-          # Raise an error unless an active connection is available.
-          def ensure_manager!
-            raise "Must have active connection" unless @manager
-          end
-        end
-      end
-    end
-  end
-end