google-gax 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8f8fbb8074fa13d17a67dc1e137f8320ed9736c
-  data.tar.gz: 90ec64abac56020821a06406097b2eb55624c19f
+  metadata.gz: 7fb40d292b456b41ebc200bcffb22da7e4ca50da
+  data.tar.gz: b9fcf56ab01370e96b5994882ebb920269d40a73
 SHA512:
-  metadata.gz: 0dec6538bac3b781afcd5a1e8a6595115403e39136cd72f694cc97103e0a9e6bc84a44b152d3d508a9e25d19d6717d606443d11f09bbb41431933a74b42b4269
-  data.tar.gz: 95d8c3af7900cf43432db82b93f0502c64fc367ef342b6fddefb9e827ec8ea453a7150d32b0b5a3633209b8ff93bc4e3e229854b85186a95ca2e1116b3fed06d
+  metadata.gz: 721417435023acd011e44287fa6d4cbeabc98b45f411f5d87bdd4a3bc672ea92d991e29957fadfa394d98b4d5696ca88cc55ed837ccbebc7513e934ae1d58cca
+  data.tar.gz: dda6c253c18408035897de6c50724609e03f3d7cfa799c2d246b981ad950c9a5313379da769723ea1f8c55f46192ee70f6d6528973cacf3db44ad7397c860c9d

data/lib/google/gax.rb

@@ -32,6 +32,7 @@ require 'google/gax/constants'
 require 'google/gax/errors'
 require 'google/gax/path_template'
 require 'google/gax/settings'
+require 'google/gax/util'
 require 'google/gax/version'
 
 module Google

data/lib/google/gax/util.rb

@@ -0,0 +1,130 @@
+# Copyright 2017, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Google
+  # Gax defines Google API extensions
+  module Gax
+    # Creates an instance of a protobuf message from a hash that may include
+    # nested hashes. `google/protobuf` allows for the instantiation of protobuf
+    # messages using hashes but does not allow for nested hashes to instantiate
+    # nested submessages.
+    #
+    # @param hash [Hash] The hash to be converted into a proto message.
+    # @param message_class [Class] The corresponding protobuf message class of
+    #   the given hash.
+    #
+    # @return [Object] An instance of the given message class.
+    def to_proto(hash, message_class)
+      hash = coerce_submessages(hash, message_class)
+      message_class.new(hash)
+    end
+
+    # Coerces values of the given hash to be acceptable by the instantiation
+    #   method provided by `google/protobuf`
+    #
+    # @private
+    #
+    # @param hash [Hash] The hash whose nested hashes will be coerced.
+    # @param message_class [Class] The corresponding protobuf message class of
+    #   the given hash.
+    #
+    # @return [Hash] A hash whose nested hashes have been coerced.
+    def coerce_submessages(hash, message_class)
+      return nil if hash.nil?
+      coerced = {}
+      message_descriptor = message_class.descriptor
+      hash.each do |key, val|
+        field_descriptor = message_descriptor.lookup(key.to_s)
+        if field_descriptor && field_descriptor.type == :message
+          coerced[key] = coerce_submessage(val, field_descriptor)
+        else
+          # `google/protobuf` should throw an error if no field descriptor is
+          # found. Simply pass through.
+          coerced[key] = val
+        end
+      end
+      coerced
+    end
+
+    # Coerces the value of a field to be acceptable by the instantiation method
+    # of the wrapping message.
+    #
+    # @private
+    #
+    # @param val [Object] The value to be coerced.
+    # @param field_descriptor [Google::Protobuf::FieldDescriptor] The field
+    #   descriptor of the value.
+    #
+    # @return [Object] The coerced version of the given value.
+    def coerce_submessage(val, field_descriptor)
+      if field_descriptor.label == :repeated
+        coerce_array(val, field_descriptor)
+      else
+        coerce(val, field_descriptor)
+      end
+    end
+
+    # Coerces the values of an array to be acceptable by the instantiation
+    # method the wrapping message.
+    #
+    # @private
+    #
+    # @param array [Array<Object>] The values to be coerced.
+    # @param field_descriptor [Google::Protobuf::FieldDescriptor] The field
+    #   descriptor of the values.
+    #
+    # @return [Array<Object>] The coerced version of the given values.
+    def coerce_array(array, field_descriptor)
+      raise ArgumentError unless array.is_a? Array
+      array.map do |val|
+        coerce(val, field_descriptor)
+      end
+    end
+
+    # Coerces the value of a field to be acceptable by the instantiation method
+    # of the wrapping message.
+    #
+    # @private
+    #
+    # @param val [Object] The value to be coerced.
+    # @param field_descriptor [Google::Protobuf::FieldDescriptor] The field
+    #   descriptor of the value.
+    #
+    # @return [Object] The coerced version of the given value.
+    def coerce(val, field_descriptor)
+      return val unless val.is_a? Hash
+      to_proto(val, field_descriptor.subtype.msgclass)
+    end
+
+    module_function :to_proto, :coerce_submessages, :coerce_submessage,
+                    :coerce_array, :coerce
+    private_class_method :coerce_submessages, :coerce_submessage, :coerce_array,
+                         :coerce
+  end
+end

data/lib/google/gax/version.rb

@@ -29,6 +29,6 @@
 
 module Google
   module Gax
-    VERSION = '0.8.3'.freeze
+    VERSION = '0.8.4'.freeze
   end
 end

data/spec/fixtures/fixture.proto

@@ -0,0 +1,35 @@
+// Copyright 2016 Google Inc.
+//
+// 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.
+syntax = "proto3";
+
+package google.protobuf;
+
+message Request {
+  string name = 1;
+  User user = 2;
+}
+
+message User {
+  enum UserType {
+    UNSPECIFIED = 0;
+    ADMINISTRATOR = 1;
+  }
+  string name = 1;
+  UserType type = 2;
+  repeated Post posts = 3;
+}
+
+message Post {
+  string text = 1;
+}

data/spec/fixtures/fixture_pb.rb

@@ -0,0 +1,32 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: fixture.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.protobuf.Request" do
+    optional :name, :string, 1
+    optional :user, :message, 2, "google.protobuf.User"
+  end
+  add_message "google.protobuf.User" do
+    optional :name, :string, 1
+    optional :type, :enum, 2, "google.protobuf.User.UserType"
+    repeated :posts, :message, 3, "google.protobuf.Post"
+  end
+  add_enum "google.protobuf.User.UserType" do
+    value :UNSPECIFIED, 0
+    value :ADMINISTRATOR, 1
+  end
+  add_message "google.protobuf.Post" do
+    optional :text, :string, 1
+  end
+end
+
+module Google
+  module Protobuf
+    Request = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.Request").msgclass
+    User = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.User").msgclass
+    User::UserType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.User.UserType").enummodule
+    Post = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.Post").msgclass
+  end
+end

data/spec/google/gax/util_spec.rb

@@ -0,0 +1,104 @@
+# Copyright 2017, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'google/gax'
+require 'spec/fixtures/fixture_pb'
+
+describe Google::Gax do
+  describe '#to_proto' do
+    REQUEST_NAME = 'path/to/ernest'.freeze
+    USER_NAME = 'Ernest'.freeze
+    USER_TYPE = :ADMINISTRATOR
+    POST_TEXT = 'This is a test post.'.freeze
+
+    it 'creates a protobuf message from a simple hash' do
+      hash = { name: USER_NAME, type: USER_TYPE }
+      user = Google::Gax.to_proto(hash, Google::Protobuf::User)
+      expect(user).to be_an_instance_of(Google::Protobuf::User)
+      expect(user.name).to eq(USER_NAME)
+      expect(user.type).to eq(USER_TYPE)
+    end
+
+    it 'creates a protobuf message from a hash with a nested message' do
+      request_hash = {
+        name: REQUEST_NAME,
+        user: Google::Protobuf::User.new(name: USER_NAME, type: USER_TYPE)
+      }
+      request = Google::Gax.to_proto(request_hash, Google::Protobuf::Request)
+      expect(request).to be_an_instance_of(Google::Protobuf::Request)
+      expect(request.name).to eq(REQUEST_NAME)
+      expect(request.user).to be_an_instance_of(Google::Protobuf::User)
+      expect(request.user.name).to eq(USER_NAME)
+      expect(request.user.type).to eq(USER_TYPE)
+    end
+
+    it 'creates a protobuf message from a hash with a nested hash' do
+      request_hash = {
+        name: REQUEST_NAME,
+        user: { name: USER_NAME, type: USER_TYPE }
+      }
+      request = Google::Gax.to_proto(request_hash, Google::Protobuf::Request)
+      expect(request).to be_an_instance_of(Google::Protobuf::Request)
+      expect(request.name).to eq(REQUEST_NAME)
+      expect(request.user).to be_an_instance_of(Google::Protobuf::User)
+      expect(request.user.name).to eq(USER_NAME)
+      expect(request.user.type).to eq(USER_TYPE)
+    end
+
+    it 'handles nested arrays of both messages and hashes' do
+      user_hash = {
+        name: USER_NAME,
+        type: USER_TYPE,
+        posts: [
+          { text: POST_TEXT },
+          Google::Protobuf::Post.new(text: POST_TEXT)
+        ]
+      }
+      user = Google::Gax.to_proto(user_hash, Google::Protobuf::User)
+      expect(user).to be_an_instance_of(Google::Protobuf::User)
+      expect(user.name).to eq(USER_NAME)
+      expect(user.type).to eq(USER_TYPE)
+      expect(user.posts).to be_a(Google::Protobuf::RepeatedField)
+      user.posts.each do |post|
+        expect(post).to be_an_instance_of(Google::Protobuf::Post)
+        expect(post.text).to eq(POST_TEXT)
+      end
+    end
+
+    it 'fails if a key does not exist in the target message type' do
+      user_hash = {
+        name: USER_NAME,
+        fake_key: 'fake data'
+      }
+      expect do
+        Google::Gax.to_proto(user_hash, Google::Protobuf::User)
+      end.to raise_error(ArgumentError)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -126,16 +126,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: 0.47.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: 0.47.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -167,14 +167,18 @@ files:
 - lib/google/gax/operation.rb
 - lib/google/gax/path_template.rb
 - lib/google/gax/settings.rb
+- lib/google/gax/util.rb
 - lib/google/gax/version.rb
 - lib/google/longrunning/operations_client.rb
 - lib/google/longrunning/operations_client_config.json
+- spec/fixtures/fixture.proto
+- spec/fixtures/fixture_pb.rb
 - spec/google/gax/api_callable_spec.rb
 - spec/google/gax/bundling_spec.rb
 - spec/google/gax/operation_spec.rb
 - spec/google/gax/path_template_spec.rb
 - spec/google/gax/settings_spec.rb
+- spec/google/gax/util_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/googleapis/gax-ruby
 licenses: