gcloud 0.11.0 → 0.12.0

data/lib/gcloud/pubsub/service.rb

@@ -13,9 +13,10 @@
 # limitations under the License.
 
 
+require "gcloud/backoff"
+require "gcloud/errors"
 require "google/pubsub/v1/pubsub_services"
 require "google/iam/v1/iam_policy_services"
-require "gcloud/backoff"
 require "gcloud/grpc_utils"
 require "json"
 
@@ -25,14 +26,16 @@ module Gcloud
     # @private Represents the gRPC Pub/Sub service, including all the API
     # methods.
     class Service
-      attr_accessor :project, :credentials, :host
+      attr_accessor :project, :credentials, :host, :retries, :timeout
 
       ##
       # Creates a new Service instance.
-      def initialize project, credentials
+      def initialize project, credentials, host: nil, retries: nil, timeout: nil
         @project = project
         @credentials = credentials
-        @host = "pubsub.googleapis.com"
+        @host = host || "pubsub.googleapis.com"
+        @retries = retries
+        @timeout = timeout
       end
 
       def creds
@@ -43,19 +46,22 @@ module Gcloud
 
       def subscriber
         return mocked_subscriber if mocked_subscriber
-        @subscriber ||= Google::Pubsub::V1::Subscriber::Stub.new host, creds
+        @subscriber ||= Google::Pubsub::V1::Subscriber::Stub.new(
+          host, creds, timeout: timeout)
       end
       attr_accessor :mocked_subscriber
 
       def publisher
         return mocked_publisher if mocked_publisher
-        @publisher ||= Google::Pubsub::V1::Publisher::Stub.new host, creds
+        @publisher ||= Google::Pubsub::V1::Publisher::Stub.new(
+          host, creds, timeout: timeout)
       end
       attr_accessor :mocked_publisher
 
       def iam
         return mocked_iam if mocked_iam
-        @iam ||= Google::Iam::V1::IAMPolicy::Stub.new host, creds
+        @iam ||= Google::Iam::V1::IAMPolicy::Stub.new(
+          host, creds, timeout: timeout)
       end
       attr_accessor :mocked_iam
 
@@ -74,7 +80,7 @@ module Gcloud
           r.topic = topic_path(topic_name, options)
         end
 
-        backoff { publisher.get_topic topic_req }
+        execute { publisher.get_topic topic_req }
       end
 
       ##
@@ -86,7 +92,7 @@ module Gcloud
           r.page_size = options[:max] if options[:max]
         end
 
-        backoff { publisher.list_topics topics_req }
+        execute { publisher.list_topics topics_req }
       end
 
       ##
@@ -96,7 +102,7 @@ module Gcloud
           r.name = topic_path(topic_name, options)
         end
 
-        backoff { publisher.create_topic topic_req }
+        execute { publisher.create_topic topic_req }
       end
 
       ##
@@ -109,7 +115,7 @@ module Gcloud
           r.topic = topic_path(topic_name)
         end
 
-        backoff { publisher.delete_topic topic_req }
+        execute { publisher.delete_topic topic_req }
       end
 
       ##
@@ -126,7 +132,7 @@ module Gcloud
           end
         )
 
-        backoff { publisher.publish publish_req }
+        execute { publisher.publish publish_req }
       end
 
       ##
@@ -136,7 +142,7 @@ module Gcloud
           subscription: subscription_path(subscription_name, options)
         )
 
-        backoff { subscriber.get_subscription sub_req }
+        execute { subscriber.get_subscription sub_req }
       end
 
       ##
@@ -148,7 +154,7 @@ module Gcloud
         list_req = Google::Pubsub::V1::ListTopicSubscriptionsRequest.new \
           list_params
 
-        backoff { publisher.list_topic_subscriptions list_req }
+        execute { publisher.list_topic_subscriptions list_req }
       end
 
       ##
@@ -159,7 +165,7 @@ module Gcloud
                         page_size:  options[:max] }.delete_if { |_, v| v.nil? }
         list_req = Google::Pubsub::V1::ListSubscriptionsRequest.new list_params
 
-        backoff { subscriber.list_subscriptions list_req }
+        execute { subscriber.list_subscriptions list_req }
       end
 
       ##
@@ -176,7 +182,7 @@ module Gcloud
             attributes: (options[:attributes] || {}).to_h)
         end
 
-        backoff { subscriber.create_subscription sub_req }
+        execute { subscriber.create_subscription sub_req }
       end
 
       ##
@@ -187,7 +193,7 @@ module Gcloud
           subscription: subscription_path(subscription)
         )
 
-        backoff { subscriber.delete_subscription del_req }
+        execute { subscriber.delete_subscription del_req }
       end
 
       ##
@@ -199,7 +205,7 @@ module Gcloud
           max_messages: options.fetch(:max, 100).to_i
         )
 
-        backoff { subscriber.pull pull_req }
+        execute { subscriber.pull pull_req }
       end
 
       ##
@@ -210,7 +216,7 @@ module Gcloud
           ack_ids: ack_ids
         )
 
-        backoff { subscriber.acknowledge ack_req }
+        execute { subscriber.acknowledge ack_req }
       end
 
       ##
@@ -227,7 +233,7 @@ module Gcloud
           )
         )
 
-        backoff { subscriber.modify_push_config mpc_req }
+        execute { subscriber.modify_push_config mpc_req }
       end
 
       ##
@@ -239,7 +245,7 @@ module Gcloud
           ack_deadline_seconds: deadline
         )
 
-        backoff { subscriber.modify_ack_deadline mad_req }
+        execute { subscriber.modify_ack_deadline mad_req }
       end
 
       def get_topic_policy topic_name, options = {}
@@ -247,16 +253,16 @@ module Gcloud
           resource: topic_path(topic_name, options)
         )
 
-        backoff { iam.get_iam_policy get_req }
+        execute { iam.get_iam_policy get_req }
       end
 
       def set_topic_policy topic_name, new_policy, options = {}
         set_req = Google::Iam::V1::SetIamPolicyRequest.new(
           resource: topic_path(topic_name, options),
-          policy: Google::Iam::V1::Policy.decode_json(JSON.dump(new_policy))
+          policy: new_policy
         )
 
-        backoff { iam.set_iam_policy set_req }
+        execute { iam.set_iam_policy set_req }
       end
 
       def test_topic_permissions topic_name, permissions, options = {}
@@ -265,7 +271,7 @@ module Gcloud
           permissions: permissions
         )
 
-        backoff { iam.test_iam_permissions test_req }
+        execute { iam.test_iam_permissions test_req }
       end
 
       def get_subscription_policy subscription_name, options = {}
@@ -273,16 +279,16 @@ module Gcloud
           resource: subscription_path(subscription_name, options)
         )
 
-        backoff { iam.get_iam_policy get_req }
+        execute { iam.get_iam_policy get_req }
       end
 
       def set_subscription_policy subscription_name, new_policy, options = {}
         set_req = Google::Iam::V1::SetIamPolicyRequest.new(
           resource: subscription_path(subscription_name, options),
-          policy: Google::Iam::V1::Policy.decode_json(JSON.dump(new_policy))
+          policy: new_policy
         )
 
-        backoff { iam.set_iam_policy set_req }
+        execute { iam.set_iam_policy set_req }
       end
 
       def test_subscription_permissions subscription_name,
@@ -292,7 +298,7 @@ module Gcloud
           permissions: permissions
         )
 
-        backoff { iam.test_iam_permissions test_req }
+        execute { iam.test_iam_permissions test_req }
       end
 
       def project_path options = {}
@@ -316,10 +322,12 @@ module Gcloud
 
       protected
 
-      def backoff options = {}
-        Gcloud::Backoff.new(options).execute_grpc do
+      def execute
+        Gcloud::Backoff.new(retries: retries).execute_grpc do
           yield
         end
+      rescue GRPC::BadStatus => e
+        raise Error.from_error(e)
       end
     end
   end

data/lib/gcloud/pubsub/subscription.rb

@@ -114,8 +114,6 @@ module Gcloud
           push_endpoint: new_endpoint,
           attributes: {}
         ) if @grpc
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
       end
 
       ##
@@ -177,9 +175,7 @@ module Gcloud
       def delete
         ensure_service!
         service.delete_subscription name
-        return true
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
+        true
       end
 
       ##
@@ -238,9 +234,7 @@ module Gcloud
         end
         acknowledge messages if autoack
         messages
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
-      rescue Faraday::TimeoutError
+      rescue Hurley::Timeout
         []
       end
 
@@ -298,7 +292,7 @@ module Gcloud
       #     # process msg
       #   end
       #
-      # @example Limit the number of messages pulled per batch with `max`:
+      # @example Limit the number of messages pulled per API request with `max`:
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
@@ -358,8 +352,6 @@ module Gcloud
         ensure_service!
         service.acknowledge name, *ack_ids
         true
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
       end
       alias_method :ack, :acknowledge
 
@@ -392,96 +384,105 @@ module Gcloud
         ack_ids = coerce_ack_ids messages
         ensure_service!
         service.modify_ack_deadline name, ack_ids, new_deadline
-        return true
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
+        true
       end
 
       ##
-      # Gets the access control policy.
+      # Gets the [Cloud IAM](https://cloud.google.com/iam/) access control
+      # policy for this subscription.
       #
-      # By default, the policy values are memoized to reduce the number of API
-      # calls to the Pub/Sub service.
+      # @see https://cloud.google.com/pubsub/reference/rpc/google.iam.v1#iampolicy
+      #   google.iam.v1.IAMPolicy
       #
       # @param [Boolean] force Force the latest policy to be retrieved from the
       #   Pub/Sub service when `true`. Otherwise the policy will be memoized to
       #   reduce the number of API calls made to the Pub/Sub service. The
       #   default is `false`.
       #
-      # @return [Hash] Returns a hash that conforms to the following structure:
+      # @yield [policy] A block for updating the policy. The latest policy will
+      #   be read from the Pub/Sub service and passed to the block. After the
+      #   block completes, the modified policy will be written to the service.
+      # @yieldparam [Policy] policy the current Cloud IAM Policy for this
+      #   subscription
       #
-      #   {
-      #     "etag"=>"CAE=",
-      #     "bindings" => [{
-      #       "role" => "roles/viewer",
-      #       "members" => ["serviceAccount:your-service-account"]
-      #     }]
-      #   }
+      # @return [Policy] the current Cloud IAM Policy for this subscription
       #
       # @example Policy values are memoized to reduce the number of API calls:
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
       #   pubsub = gcloud.pubsub
+      #   sub = pubsub.subscription "my-subscription"
       #
-      #   subscription = pubsub.subscription "my-subscription"
-      #   puts subscription.policy["bindings"]
-      #   puts subscription.policy["rules"]
+      #   policy = sub.policy # API call
+      #   policy_2 = sub.policy # No API call
       #
       # @example Use `force` to retrieve the latest policy from the service:
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
       #   pubsub = gcloud.pubsub
+      #   sub = pubsub.subscription "my-subscription"
       #
-      #   subscription = pubsub.subscription "my-subscription"
-      #   policy = subscription.policy force: true
+      #   policy = sub.policy force: true # API call
+      #   policy_2 = sub.policy force: true # API call
+      #
+      # @example Update the policy by passing a block:
+      #   require "gcloud"
+      #
+      #   gcloud = Gcloud.new
+      #   pubsub = gcloud.pubsub
+      #   sub = pubsub.subscription "my-subscription"
+      #
+      #   policy = sub.policy do |p|
+      #     p.add "roles/owner", "user:owner@example.com"
+      #   end # 2 API calls
       #
       def policy force: nil
-        @policy = nil if force
+        @policy = nil if force || block_given?
         @policy ||= begin
           ensure_service!
           grpc = service.get_subscription_policy name
-          JSON.parse(Google::Iam::V1::Policy.encode_json(grpc))
-        rescue GRPC::BadStatus => e
-          raise Error.from_error(e)
+          Policy.from_grpc grpc
         end
+        return @policy unless block_given?
+        p = @policy.deep_dup
+        yield p
+        self.policy = p
       end
 
       ##
-      # Sets the access control policy.
+      # Updates the [Cloud IAM](https://cloud.google.com/iam/) access control
+      # policy for this subscription. The policy should be read from {#policy}.
+      # See {Gcloud::Pubsub::Policy} for an explanation of the policy `etag`
+      # property and how to modify policies.
+      #
+      # You can also update the policy by passing a block to {#policy}, which
+      # will call this method internally after the block completes.
       #
-      # @param [String] new_policy A hash that conforms to the following
-      #   structure:
+      # @see https://cloud.google.com/pubsub/reference/rpc/google.iam.v1#iampolicy
+      #   google.iam.v1.IAMPolicy
       #
-      #     {
-      #       "bindings" => [{
-      #         "role" => "roles/viewer",
-      #         "members" => ["serviceAccount:your-service-account"]
-      #       }]
-      #     }
+      # @param [Policy] new_policy a new or modified Cloud IAM Policy for this
+      #   subscription
       #
       # @example
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
       #   pubsub = gcloud.pubsub
+      #   sub = pubsub.subscription "my-subscription"
+      #
+      #   policy = sub.policy # API call
+      #
+      #   policy.add "roles/owner", "user:owner@example.com"
       #
-      #   viewer_policy = {
-      #     "bindings" => [{
-      #       "role" => "roles/viewer",
-      #       "members" => ["serviceAccount:your-service-account"]
-      #     }]
-      #   }
-      #   subscription = pubsub.subscription "my-subscription"
-      #   subscription.policy = viewer_policy
+      #   sub.policy = policy # API call
       #
       def policy= new_policy
         ensure_service!
-        grpc = service.set_subscription_policy name, new_policy
-        @policy = JSON.parse(Google::Iam::V1::Policy.encode_json(grpc))
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
+        grpc = service.set_subscription_policy name, new_policy.to_grpc
+        @policy = Policy.from_grpc grpc
       end
 
       ##
@@ -522,8 +523,6 @@ module Gcloud
         ensure_service!
         grpc = service.test_subscription_permissions name, permissions
         grpc.permissions
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
       end
 
       ##
@@ -551,8 +550,6 @@ module Gcloud
         ensure_service!
         return @grpc if @grpc
         @grpc = service.get_subscription @name
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
       end
 
       ##