gcloud 0.12.2 → 0.20.0

data/lib/gcloud/pubsub/topic/list.rb

@@ -1,174 +0,0 @@
-# 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 "delegate"
-
-module Gcloud
-  module Pubsub
-    class Topic
-      ##
-      # Topic::List is a special case Array with additional values.
-      class List < DelegateClass(::Array)
-        ##
-        # If not empty, indicates that there are more topics
-        # that match the request and this value should be passed to
-        # the next {Gcloud::Pubsub::Project#topics} to continue.
-        attr_accessor :token
-
-        ##
-        # @private Create a new Topic::List with an array of values.
-        def initialize arr = []
-          super arr
-        end
-
-        ##
-        # Whether there a next page of topics.
-        #
-        # @return [Boolean]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   pubsub = gcloud.pubsub
-        #
-        #   topics = pubsub.topics
-        #   if topics.next?
-        #     next_topics = topics.next
-        #   end
-        #
-        def next?
-          !token.nil?
-        end
-
-        ##
-        # Retrieve the next page of topics.
-        #
-        # @return [Topic::List]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   pubsub = gcloud.pubsub
-        #
-        #   topics = pubsub.topics
-        #   if topics.next?
-        #     next_topics = topics.next
-        #   end
-        #
-        def next
-          return nil unless next?
-          ensure_service!
-          options = { token: token, max: @max }
-          grpc = @service.list_topics options
-          self.class.from_grpc grpc, @service, @max
-        end
-
-        ##
-        # Retrieves all topics by repeatedly loading {#next} until {#next?}
-        # returns `false`. Calls the given block once for each topic, which is
-        # passed as the parameter.
-        #
-        # An Enumerator is returned if no block is given.
-        #
-        # This method may make several API calls until all topics 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 topics. Default is no limit.
-        # @yield [topic] The block for accessing each topic.
-        # @yieldparam [Topic] topic The topic object.
-        #
-        # @return [Enumerator]
-        #
-        # @example Iterating each topic by passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   pubsub = gcloud.pubsub
-        #
-        #   topics = pubsub.topics
-        #   topics.all do |topic|
-        #     puts topic.name
-        #   end
-        #
-        # @example Using the enumerator by not passing a block:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   pubsub = gcloud.pubsub
-        #
-        #   topics = pubsub.topics
-        #   all_names = topics.all.map do |topic|
-        #     topic.name
-        #   end
-        #
-        # @example Limit the number of API calls made:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   pubsub = gcloud.pubsub
-        #
-        #   topics = pubsub.topics
-        #   topics.all(request_limit: 10) do |topic|
-        #     puts topic.name
-        #   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 Topic::List from a Google::Pubsub::V1::ListTopicsResponse
-        # object.
-        def self.from_grpc grpc_list, service, max = nil
-          topics = new(Array(grpc_list.topics).map do |grpc|
-            Topic.from_grpc grpc, service
-          end)
-          token = grpc_list.next_page_token
-          token = nil if token == ""
-          topics.instance_variable_set "@token",   token
-          topics.instance_variable_set "@service", service
-          topics.instance_variable_set "@max",     max
-          topics
-        end
-
-        protected
-
-        ##
-        # @private Raise an error unless an active connection to the service is
-        # available.
-        def ensure_service!
-          fail "Must have active connection to service" unless @service
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/pubsub/topic/publisher.rb

@@ -1,85 +0,0 @@
-# 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 Gcloud
-  module Pubsub
-    class Topic
-      ##
-      # Topic Publisher object used to publish multiple messages at once.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   pubsub = gcloud.pubsub
-      #
-      #   topic = pubsub.topic "my-topic"
-      #   msgs = topic.publish do |t|
-      #     t.publish "new-message-1", foo: :bar
-      #     t.publish "new-message-2", foo: :baz
-      #     t.publish "new-message-3", foo: :bif
-      #   end
-      class Publisher
-        ##
-        # @private The messages to publish
-        attr_reader :messages
-
-        ##
-        # @private Create a new instance of the object.
-        def initialize data = nil, attributes = {}
-          @messages = []
-          @mode = :batch
-          return if data.nil?
-          @mode = :single
-          publish data, attributes
-        end
-
-        ##
-        # Add multiple messages to the topic.
-        # All messages added will be published at once.
-        # See {Gcloud::Pubsub::Topic#publish}
-        def publish data, attributes = {}
-          # Convert IO-ish objects to strings
-          if data.respond_to?(:read) && data.respond_to?(:rewind)
-            data.rewind
-            data = data.read
-          end
-          # Convert data to encoded byte array to match the protobuf definition
-          data = String(data).force_encoding("ASCII-8BIT")
-          # Convert attributes to strings to match the protobuf definition
-          attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
-          @messages << [data, attributes]
-        end
-
-        ##
-        # @private Create Message objects with message ids.
-        def to_gcloud_messages message_ids
-          msgs = @messages.zip(Array(message_ids)).map do |arr, id|
-            Message.from_grpc(
-              Google::Pubsub::V1::PubsubMessage.new(
-                data: arr[0], attributes: arr[1], message_id: id))
-          end
-          # Return just one Message if a single publish,
-          # otherwise return the array of Messages.
-          if @mode == :single && msgs.count <= 1
-            msgs.first
-          else
-            msgs
-          end
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/resource_manager/credentials.rb

@@ -1,30 +0,0 @@
-# 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 "gcloud/credentials"
-
-module Gcloud
-  module ResourceManager
-    ##
-    # @private Represents the Oauth2 signing logic for Resource Manager.
-    class Credentials < Gcloud::Credentials
-      SCOPE = ["https://www.googleapis.com/auth/cloud-platform"]
-      PATH_ENV_VARS = %w(RESOURCE_MANAGER_KEYFILE
-                         GCLOUD_KEYFILE GOOGLE_CLOUD_KEYFILE)
-      JSON_ENV_VARS = %w(RESOURCE_MANAGER_KEYFILE_JSON GCLOUD_KEYFILE_JSON
-                         GOOGLE_CLOUD_KEYFILE_JSON)
-    end
-  end
-end

data/lib/gcloud/resource_manager/manager.rb

@@ -1,266 +0,0 @@
-# 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 "gcloud/errors"
-require "gcloud/resource_manager/credentials"
-require "gcloud/resource_manager/service"
-require "gcloud/resource_manager/project"
-
-module Gcloud
-  module ResourceManager
-    ##
-    # # Manager
-    #
-    # Provides methods for creating, retrieving, and updating projects.
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   resource_manager = gcloud.resource_manager
-    #   resource_manager.projects.each do |project|
-    #     puts projects.project_id
-    #   end
-    #
-    # See {Gcloud#resource_manager}
-    class Manager
-      ##
-      # @private The Service object.
-      attr_accessor :service
-
-      ##
-      # @private Creates a new Service instance.
-      #
-      # See {Gcloud.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.
-      #   * <code>labels.color:red labels.size:big</code> - 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<Gcloud::ResourceManager::Project>] (See
-      #   {Gcloud::ResourceManager::Project::List})
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   projects = resource_manager.projects
-      #
-      #   projects.each do |project|
-      #     puts project.project_id
-      #   end
-      #
-      # @example Projects can be filtered using the `filter` option:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   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 "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   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 [Gcloud::ResourceManager::Project, nil] Returns `nil` if the
-      #   project does not exist
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   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:
-      #   <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.
-      #
-      # @return [Gcloud::ResourceManager::Project]
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   project = resource_manager.create_project "tokyo-rain-123"
-      #
-      # @example A project can also be created with a `name` and `labels`:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   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
-        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 "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   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 "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   resource_manager = gcloud.resource_manager
-      #   resource_manager.undelete "tokyo-rain-123"
-      #
-      def undelete project_id
-        service.undelete_project project_id
-        true
-      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