google-gax 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec76cdd33b0b9fa99cacf500fe8dfdffb3d74a38
-  data.tar.gz: ab2e1c9b639932dc661876970be636890339a2bf
+  metadata.gz: 9c4b4e8a1661f0a0734a310e5969872001666206
+  data.tar.gz: f2af4244cfd73b82bff30393ff21ef5d6bcbc4e3
 SHA512:
-  metadata.gz: 641d4a0082acdff4c9d33e22e9e6ce06686863c913d3401fb8204dc0ecaaa5bce4ae2d20296557f6e4f6ce160d64ad9653db9762af31913347de04d3d1152548
-  data.tar.gz: da6bf4c3bdb36641c935ebd0e9bf23254927d23d2a117ed6d07d5330ee28ad272f887503de9ced775b0161d8d19304c94091e6be6a6308108a74fe5a95d0a80f
+  metadata.gz: 9f3c887fb4413c90d7397024a5da6fcf280e656a6dd5fd0e8707e292a955bb0731637c13ec4dbd596750070b314ea431506a80474384716a0227fd4998b044df
+  data.tar.gz: b487c73d5bf55f2e135a089b1b6147fbe756b63c73fef312d1c5df7fdb0db8290b58ca5cf7a109124e94b8a5689bd5e877ce0fde260e5608156845526c009b85

data/lib/google/gax/operation.rb

@@ -121,22 +121,27 @@ module Google
         @callbacks = []
       end
 
-      # If the operation is done, returns the result, otherwise returns nil.
+      # If the operation is done, returns the response.
       # If the operation response is an error, the error will be returned.
-      # If a type is provided, the response will be unpacked using the type
-      # provided; returning nil if the response is not of the type provided.
-      # If the type is not of provided, the response will be unpacked using
-      # the response's type_url if the type_url is found in the
-      # Google::Protobuf::DescriptorPool.generated_pool.
-      # If the type cannot be found the raw response is retuned.
+      # Otherwise returns nil.
       #
       # @return [Object, Google::Rpc::Status, nil]
       #   The result of the operation. If it is an error a Google::Rpc::Status
       #   will be returned.
       def results
-        return nil unless done?
-        return @grpc_op.error if error?
-        @grpc_op.response.unpack(@result_type)
+        return error if error?
+        return response if response?
+      end
+
+      # Returns the server-assigned name of the operation, which is only unique
+      # within the same service that originally returns it. If you use the
+      # default HTTP mapping, the name should have the format of
+      # operations/some/unique/name.
+      #
+      # @return [String]
+      #   The name of the operation.
+      def name
+        @grpc_op.name
       end
 
       # Returns the metadata of an operation. If a type is provided,
@@ -162,6 +167,22 @@ module Google
         @grpc_op.done
       end
 
+      # Checks if the operation is done and the result is a response.
+      # If the operation is not finished then this will return false.
+      #
+      # @return [Boolean] Whether a response has been returned.
+      def response?
+        done? ? @grpc_op.result == :response : false
+      end
+
+      # If the operation is done, returns the response, otherwise returns nil.
+      #
+      # @return [Object, nil]
+      #   The response of the operation.
+      def response
+        @grpc_op.response.unpack(@result_type) if response?
+      end
+
       # Checks if the operation is done and the result is an error.
       # If the operation is not finished then this will return false.
       #
@@ -170,11 +191,25 @@ module Google
         done? ? @grpc_op.result == :error : false
       end
 
+      # If the operation response is an error, the error will be returned,
+      # otherwise returns nil.
+      #
+      # @return [Google::Rpc::Status, nil]
+      #   The error object.
+      def error
+        @grpc_op.error if error?
+      end
+
       # Cancels the operation.
       def cancel
         @client.cancel_operation(@grpc_op.name)
       end
 
+      # Deletes the operation.
+      def delete
+        @client.delete_operation(@grpc_op.name)
+      end
+
       # Reloads the operation object.
       #
       # @return [Google::Gax::Operation]

data/lib/google/gax/version.rb

@@ -29,6 +29,6 @@
 
 module Google
   module Gax
-    VERSION = '0.7.1'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

data/spec/google/gax/operation_spec.rb

@@ -43,9 +43,10 @@ GaxOp = Google::Gax::Operation
 MILLIS_PER_SECOND = Google::Gax::MILLIS_PER_SECOND
 
 class MockLroClient
-  def initialize(get_method: nil, cancel_method: nil)
+  def initialize(get_method: nil, cancel_method: nil, delete_method: nil)
     @get_method = get_method
     @cancel_method = cancel_method
+    @delete_method = delete_method
   end
 
   def get_operation(grpc_method, options: nil)
@@ -55,6 +56,10 @@ class MockLroClient
   def cancel_operation(name)
     @cancel_method.call(name)
   end
+
+  def delete_operation(name)
+    @delete_method.call(name)
+  end
 end
 
 RESULT_ANY = Google::Protobuf::Any.new
@@ -99,6 +104,13 @@ describe Google::Gax::Operation do
     end
   end
 
+  context 'method `name`' do
+    it 'should return the operation name' do
+      op = create_op(GrpcOp.new(done: true, name: '1234567890'))
+      expect(op.name).to eq('1234567890')
+    end
+  end
+
   context 'method `metadata`' do
     it 'should unpack the metadata' do
       op = create_op(GrpcOp.new(done: true, metadata: METADATA_ANY))
@@ -124,12 +136,65 @@ describe Google::Gax::Operation do
       expect(op.error?).to eq(true)
     end
 
-    it 'should return true on finished operation.' do
+    it 'should return false on finished operation.' do
       op = create_op(GrpcOp.new(done: true, response: RESULT_ANY))
       expect(op.error?).to eq(false)
     end
   end
 
+  context 'method `error`' do
+    it 'should return nil on unfinished operation.' do
+      op = create_op(GrpcOp.new(done: false))
+      expect(op.error).to eq(nil)
+    end
+
+    it 'should return error on error operation.' do
+      error = Google::Rpc::Status.new
+      op = create_op(GrpcOp.new(done: true, error: error))
+      expect(op.error).to eq(error)
+    end
+
+    it 'should return nil on finished operation.' do
+      op = create_op(GrpcOp.new(done: true, response: RESULT_ANY))
+      expect(op.error).to eq(nil)
+    end
+  end
+
+  context 'method `response?`' do
+    it 'should return false on unfinished operation.' do
+      expect(create_op(GrpcOp.new(done: false)).response?).to eq(false)
+    end
+
+    it 'should return false on error operation.' do
+      error = Google::Rpc::Status.new
+      op = create_op(GrpcOp.new(done: true, error: error))
+      expect(op.response?).to eq(false)
+    end
+
+    it 'should return true on finished operation.' do
+      op = create_op(GrpcOp.new(done: true, response: RESULT_ANY))
+      expect(op.response?).to eq(true)
+    end
+  end
+
+  context 'method `response`' do
+    it 'should return nil on unfinished operation.' do
+      op = create_op(GrpcOp.new(done: false))
+      expect(op.response).to eq(nil)
+    end
+
+    it 'should return nil on error operation.' do
+      error = Google::Rpc::Status.new
+      op = create_op(GrpcOp.new(done: true, error: error))
+      expect(op.response).to eq(nil)
+    end
+
+    it 'should result on finished operation.' do
+      op = create_op(GrpcOp.new(done: true, response: RESULT_ANY))
+      expect(op.response).to eq(RESULT)
+    end
+  end
+
   context 'method `cancel`' do
     it 'should call the clients cancel_operation' do
       op_name = 'test_name'
@@ -144,6 +209,20 @@ describe Google::Gax::Operation do
     end
   end
 
+  context 'method `delete`' do
+    it 'should call the clients delete_operation' do
+      op_name = 'test_name'
+      called = false
+      delete_method = proc do |name|
+        expect(name).to eq(op_name)
+        called = true
+      end
+      mock_client = MockLroClient.new(delete_method: delete_method)
+      create_op(GrpcOp.new(name: op_name), client: mock_client).delete
+      expect(called).to eq(true)
+    end
+  end
+
   context 'method `reload!`' do
     it 'should call the get_operation of the client' do
       called = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -196,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Aids the development of APIs for clients and servers based on GRPC and Google