Add LRO wrapper. #47

landrito · 2016-10-25T00:03:03Z

Still needed:

Unit tests (Exponential retrying still needed)
Finished design review from gcloud-ruby

lib/google/gax/operation.rb

+      #   The client that handles the grpc operations.
+      def initialize(grpc_op, client: nil)
+        @grpc_op = grpc_op
+        @client = client.nil? Google::Longrunning::OperationsApi.new : client


lib/google/gax/operation.rb

+      def results
+        return nil unless done?
+        return @grpc_op.error if @grpc_op.result == :error
+        @grpc_op.response.value if @grpc_op.result == :response


codecov-io · 2016-10-25T00:16:18Z

Current coverage is 99.44% (diff: 99.69%)

Merging #47 into master will increase coverage by 0.21%

@@             master        #47   diff @@
==========================================
  Files            10         13     +3   
  Lines          1170       1453   +283   
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
+ Hits           1161       1445   +284   
+ Misses            9          8     -1   
  Partials          0          0

Powered by Codecov. Last update 297c819...0319620

lib/google/gax/operation.rb

+        )
+        @grpc_op = @client.get_operation @grpc_op.name, options: options
+        if done?
+          callbacks.each { |proc| proc.call(results) }


lib/google/gax/operation.rb

+      # Registers a callback to be run when a refreshed operation is marked
+      # as done. If the operation has completed prior to a call to this function
+      # the callback will be called instead of registered.
+      def on_done


lib/google/gax/operation.rb

+      # as done. If the operation has completed prior to a call to this function
+      # the callback will be called instead of registered.
+      def on_done(&block)
+        if done?


spec/google/gax/operation_spec.rb

+      end
+    end
+
+    # TODO: Test exponential backoff.


lib/google/gax/operation.rb

+        return @grpc_op.error if error?
+        return @grpc_op.response.unpack(response_type) if response_type
+        @grpc_op.response
+      end


…esting.

landrito · 2016-11-10T00:51:12Z

Added some logic to unpack results based on the response. And the test for exponential backoff. @jmuk PTAL

lib/google/gax/operation.rb

+      # unpacked from the response. If the response is not of the type provided
+      # nil will be returned.
+      #
+      # @param [Class] The class type to be unpacked from the response.


lib/google/gax/operation.rb

+
+      # Cancels the operation.
+      def cancel
+        @client.cancel_operation @grpc_op.name


lib/google/gax/operation.rb

+        @grpc_op.response
+      end
+
+      def metadata(type: nil)


lib/google/gax/operation.rb

+    #   @return [Google::Gax::CallOptions] The call options used when reloading
+    #     the operation.
+    class Operation
+      attr_reader :grpc_op, :client


lib/google/gax/operation.rb

+    # @attribute [r] grpc_op
+    #   @return [Google::Longrunning::Operation] The wrapped grpc
+    #     operation object.
+    # @attribute [r] client


lib/google/gax/operation.rb

+    # @example General usage example
+    #   require 'google/gax/operation'
+    #
+    #   op = Google::Gax::Operation.new api.methodThatReturnsOperation(name)


lib/google/gax/operation.rb

+      # Google::Protobuf::DescriptorPool.generated_pool.
+      # If the type cannot be found the raw response is retuned.
+      #
+      # @param type [Class]] The class type to be unpacked from the response.


lib/google/gax/operation.rb

+      # Google::Protobuf::DescriptorPool.generated_pool.
+      # If the type cannot be found the raw metadata is retuned.
+      #
+      # @param type [Class]] The class type to be unpacked from the response.


landrito assigned jmuk and swcloud Oct 25, 2016

jmuk reviewed Oct 25, 2016

View reviewed changes

WIP Initial LRO wrapper. Tests needed.

2baf029

landrito force-pushed the lro branch from d31d6bd to 2baf029 Compare October 25, 2016 00:16

landrito force-pushed the lro branch 2 times, most recently from da356d6 to d33bd23 Compare October 25, 2016 19:32

Fixed style issues and updates to design

460869e

landrito force-pushed the lro branch from d33bd23 to 460869e Compare October 25, 2016 19:58

blowmage reviewed Oct 25, 2016

View reviewed changes

landrito force-pushed the lro branch from 21ebb28 to 88f7b92 Compare October 26, 2016 00:14

Unit tests

6ca40f3

landrito force-pushed the lro branch from 88f7b92 to 6ca40f3 Compare October 26, 2016 00:15

Style fixes.wq

35a182f

blowmage reviewed Oct 26, 2016

View reviewed changes

lib/google/gax/operation.rb

# as done. If the operation has completed prior to a call to this function

# the callback will be called instead of registered.

def on_done(&block)

if done?

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

bjwatson reviewed Nov 7, 2016

View reviewed changes

spec/google/gax/operation_spec.rb

end

end

# TODO: Test exponential backoff.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

landrito commented Nov 7, 2016

View reviewed changes

lib/google/gax/operation.rb

return @grpc_op.error if error?

return @grpc_op.response.unpack(response_type) if response_type

@grpc_op.response

end

This comment was marked as spam.

Sign in to view

Made results unpack values based on the result. Exponential backoff t…

a0f742c

…esting.

swcloud reviewed Nov 10, 2016

View reviewed changes

landrito force-pushed the lro branch 3 times, most recently from 2678d0d to ef7cd43 Compare November 10, 2016 02:35

Documentation fix

33e9ec5

landrito force-pushed the lro branch from ef7cd43 to 33e9ec5 Compare November 10, 2016 02:41

swcloud suggested changes Nov 11, 2016

View reviewed changes

swcloud mentioned this pull request Nov 11, 2016

Update gapic generated code for longrunning operation #48

Merged

Documentation fixes.

0319620

swcloud approved these changes Nov 14, 2016

View reviewed changes

landrito changed the title ~~WIP Initial LRO wrapper.~~ Add LRO wrapper. Nov 16, 2016

landrito merged commit e8c66e4 into googleapis:master Nov 21, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add LRO wrapper. #47

Add LRO wrapper. #47

landrito commented Oct 25, 2016 •

edited

Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

codecov-io commented Oct 25, 2016 •

edited

Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

landrito commented Nov 10, 2016 •

edited

Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

Add LRO wrapper. #47

Add LRO wrapper. #47

Conversation

landrito commented Oct 25, 2016 • edited Loading

Still needed:

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

codecov-io commented Oct 25, 2016 • edited Loading

Current coverage is 99.44% (diff: 99.69%)

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

landrito commented Nov 10, 2016 • edited Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

landrito commented Oct 25, 2016 •

edited

Loading

codecov-io commented Oct 25, 2016 •

edited

Loading

landrito commented Nov 10, 2016 •

edited

Loading