google-cloud-resource_manager 0.20.0

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

@@ -0,0 +1,169 @@
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# 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.
+
+
+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"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #
+          #   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"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #
+          #   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 all projects by repeatedly loading {#next} until {#next?}
+          # returns `false`. Calls the given block once for each project, which
+          # is passed as the parameter.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method may make several API calls until all projects are
+          # retrieved. Be sure to use as narrow a search criteria as possible.
+          # Please 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"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #   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"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #   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"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #   projects = resource_manager.projects
+          #
+          #   projects.all(request_limit: 10) do |project|
+          #     puts project.project_id
+          #   end
+          #
+          def all request_limit: nil
+            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 { |r| yield r }
+              if request_limit
+                request_limit -= 1
+                break if request_limit < 0
+              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!
+            fail "Must have active connection" unless @manager
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,134 @@
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# 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.
+
+
+require "time"
+
+module Google
+  module Cloud
+    module ResourceManager
+      class Project
+        ##
+        # # Project Updater
+        #
+        # This object is used by Project#update when passed a block. These
+        # methods are used to update the project data in a single API call.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   resource_manager = gcloud.resource_manager
+        #   project = resource_manager.project "tokyo-rain-123"
+        #   project.update do |p|
+        #     p.name = "My Project"
+        #     p.labels["env"] = "production"
+        #   end
+        #
+        class Updater < DelegateClass(Project)
+          ##
+          # @private Create an Updater object.
+          def initialize project
+            super project
+          end
+
+          ##
+          # Updates 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.
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #   project = resource_manager.project "tokyo-rain-123"
+          #   project.update do |p|
+          #     p.name = "My Project"
+          #   end
+          #
+          def name= new_name
+            gapi.name = new_name
+          end
+
+          ##
+          # The labels associated with this project.
+          #
+          # Label keys must be between 1 and 63 characters long and must conform
+          # to the following regular expression:
+          # <code>[a-z]([-a-z0-9]*[a-z0-9])?</code>.
+          #
+          # Label values must be between 0 and 63 characters long and must
+          # conform to the regular expression
+          # <code>([a-z]([-a-z0-9]*[a-z0-9])?)?</code>.
+          #
+          # No more than 256 labels can be associated with a given resource.
+          # (`Hash`)
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #   project = resource_manager.project "tokyo-rain-123"
+          #   project.update do |p|
+          #     p.labels["env"] = "production"
+          #   end
+          #
+          def labels
+            gapi.labels
+          end
+
+          ##
+          # Updates the labels associated with this project.
+          #
+          # Label keys must be between 1 and 63 characters long and must conform
+          # to the following regular expression:
+          # <code>[a-z]([-a-z0-9]*[a-z0-9])?</code>.
+          #
+          # Label values must be between 0 and 63 characters long and must
+          # conform to the regular expression
+          # <code>([a-z]([-a-z0-9]*[a-z0-9])?)?</code>.
+          #
+          # No more than 256 labels can be associated with a given resource.
+          # (`Hash`)
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   resource_manager = gcloud.resource_manager
+          #   project = resource_manager.project "tokyo-rain-123"
+          #   project.update do |p|
+          #     p.labels = { "env" => "production" }
+          #   end
+          #
+          def labels= new_labels
+            gapi.labels = new_labels
+          end
+
+          ##
+          # @private Create an Updater object.
+          def self.from_project project
+            dupe_gapi = project.gapi.class.new project.gapi.to_h
+            dupe_project = Project.from_gapi dupe_gapi, nil # no way to update
+            Updater.new dupe_project
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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.
+
+
+require "google/cloud/errors"
+require "google/cloud/resource_manager/version"
+require "google/apis/cloudresourcemanager_v1"
+
+module Google
+  module Cloud
+    module ResourceManager
+      ##
+      # @private
+      # Represents the service to Resource Manager, as well as expose the API
+      # calls.
+      class Service
+        ##
+        # Alias to the Google Client API module
+        API = Google::Apis::CloudresourcemanagerV1
+
+        attr_accessor :credentials
+
+        ##
+        # Creates a new Service instance.
+        def initialize credentials, retries: nil, timeout: nil
+          @credentials = credentials
+          @service = API::CloudResourceManagerService.new
+          @service.client_options.application_name = \
+            "google-cloud-resource_manager"
+          @service.client_options.application_version = \
+            Google::Cloud::ResourceManager::VERSION
+          @service.request_options.retries = retries || 3
+          @service.request_options.timeout_sec = timeout if timeout
+          @service.authorization = @credentials.client
+        end
+
+        def service
+          return mocked_service if mocked_service
+          @service
+        end
+        attr_accessor :mocked_service
+
+        ##
+        # Returns API::ListProjectsResponse
+        def list_project filter: nil, token: nil, max: nil
+          execute do
+            service.list_projects page_token: token, page_size: max,
+                                  filter: filter
+          end
+        end
+
+        ##
+        # Returns API::Project
+        def get_project project_id
+          execute { service.get_project project_id }
+        end
+
+        ##
+        # Returns API::Project
+        def create_project project_id, name, labels
+          project_attrs = { projectId: project_id, name: name,
+                            labels: labels }.delete_if { |_, v| v.nil? }
+          execute { service.create_project API::Project.new(project_attrs) }
+        end
+
+        ##
+        # Updated the project, given a API::Project.
+        # Returns API::Project
+        def update_project project_gapi
+          execute do
+            service.update_project project_gapi.project_id, project_gapi
+          end
+        end
+
+        def delete_project project_id
+          execute { service.delete_project project_id }
+        end
+
+        def undelete_project project_id
+          execute { service.undelete_project project_id }
+        end
+
+        ##
+        # Returns API::Policy
+        def get_policy project_id
+          execute { service.get_project_iam_policy "projects/#{project_id}" }
+        end
+
+        ##
+        # Returns API::Policy
+        def set_policy project_id, new_policy
+          req = API::SetIamPolicyRequest.new policy: new_policy
+          execute do
+            service.set_project_iam_policy "projects/#{project_id}", req
+          end
+        end
+
+        ##
+        # Returns API::TestIamPermissionsResponse
+        def test_permissions project_id, permissions
+          req = API::TestIamPermissionsRequest.new permissions: permissions
+          execute do
+            service.test_project_iam_permissions "projects/#{project_id}", req
+          end
+        end
+
+        def inspect
+          "#{self.class}"
+        end
+
+        protected
+
+        def execute
+          yield
+        rescue Google::Apis::Error => e
+          raise Google::Cloud::Error.from_error(e)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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.
+
+
+module Google
+  module Cloud
+    module ResourceManager
+      VERSION = "0.20.0"
+    end
+  end
+end