google-gax 0.8.12 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b97f693e0972f255cf0b0ddbbf27a63370afc04
-  data.tar.gz: 852fb0aeeeb4312fae5951bcf4a034466dcb38ee
+  metadata.gz: fddb2e602722db6f4c4aa081c4660a6a3291214c
+  data.tar.gz: 6be83a2a050318833068ccef972ae886668a5484
 SHA512:
-  metadata.gz: 5552ba83b4e65d7889df1fdec4cf3f59d07b96161c5064f7c2344f0eb8299daea86cfddd55e35a1ca01b16dba846d46c34cfe933d15974a0353624862dafc9ca
-  data.tar.gz: 1970759850a9d2ccd7f9655a688b3bf8bbb973442e9ce542dc6b53e21f412c68b3fa0cfe6d20d85f26f06de3e1f552af4ffcd64b659e21235c7f1ca3781a7ad7
+  metadata.gz: 7d6f35c2dcc528491d6a58dd6bf32813708995b20317363cc3eea067ae2358ffdb76da2809a4f12cb1968a1c2361c7cc6235a271c63dcb67e315fbff1a1a9de4
+  data.tar.gz: b9e48955378a15a297f967334ed6d7ff629a0a983acfc7e7e61b25bf6e58d87b7340717585aebe70f234973a86b2e86c79fbb1e4fd445f2dea2b010c0a6dfb19

data/lib/google/gax.rb

@@ -29,7 +29,6 @@
 
 require 'google/gax/api_callable'
 require 'google/gax/constants'
-require 'google/gax/credentials'
 require 'google/gax/errors'
 require 'google/gax/path_template'
 require 'google/gax/settings'

data/lib/google/gax/version.rb

@@ -29,6 +29,6 @@
 
 module Google
   module Gax
-    VERSION = '0.8.12'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

data/lib/google/longrunning/operations_client.rb

@@ -40,6 +40,7 @@ require "json"
 require "pathname"
 
 require "google/gax"
+require "googleauth"
 
 require "google/longrunning/operations_pb"
 
@@ -80,18 +81,12 @@ module Google
       # The scopes needed to make gRPC calls to all of the methods defined in
       # this service.
       ALL_SCOPES = [
-        "https://www.googleapis.com/auth/cloud-platform",
       ].freeze
 
-      # @param service_path [String]
-      #   The domain name of the API remote host.
-      # @param port [Integer]
-      #   The port on which to connect to the remote host.
-      # @param credentials
-      #   [Google::Gax::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+      # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
       #   Provides the means for authenticating requests made by the client. This parameter can
       #   be many types.
-      #   A `Google::Gax::Credentials` uses a the properties of its represented keyfile for
+      #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
       #   authenticating requests made by this client.
       #   A `String` will be treated as the path to the keyfile to be used for the construction of
       #   credentials for this client.
@@ -105,7 +100,7 @@ module Google
       # @param scopes [Array<String>]
       #   The OAuth scopes for this service. This parameter is ignored if
       #   an updater_proc is supplied.
-      # @param client_config[Hash]
+      # @param client_config [Hash]
       #   A Hash for call options for each method. See
       #   Google::Gax#construct_settings for the structure of
       #   this data. Falls back to the default config if not specified
@@ -122,8 +117,6 @@ module Google
           scopes: ALL_SCOPES,
           client_config: {},
           timeout: DEFAULT_TIMEOUT,
-          app_name: nil,
-          app_version: nil,
           lib_name: nil,
           lib_version: ""
         # These require statements are intentionally placed here to initialize
@@ -139,14 +132,14 @@ module Google
           credentials ||= chan_creds
           credentials ||= updater_proc
         end
-        if app_name || app_version
-          warn "`app_name` and `app_version` are no longer being used in the request headers."
+        if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
+          warn "`service_path` and `port` parameters are deprecated and will be removed"
         end
 
-        credentials ||= Google::Gax::Credentials.default(scope: scopes)
+        credentials ||= Google::Auth::Credentials.default(scopes: scopes)
 
         if credentials.is_a?(String) || credentials.is_a?(Hash)
-          updater_proc = Google::Gax::Credentials.new(credentials).updater_proc
+          updater_proc = Google::Auth::Credentials.new(credentials).updater_proc
         end
         if credentials.is_a?(GRPC::Core::Channel)
           channel = credentials
@@ -157,7 +150,7 @@ module Google
         if credentials.is_a?(Proc)
           updater_proc = credentials
         end
-        if credentials.is_a?(Google::Gax::Credentials)
+        if credentials.is_a?(Google::Auth::Credentials)
           updater_proc = credentials.updater_proc
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-gax
 version: !ruby/object:Gem::Version
-  version: 0.8.12
+  version: 0.9.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -16,42 +16,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +174,6 @@ files:
 - lib/google/gax/api_callable.rb
 - lib/google/gax/bundling.rb
 - lib/google/gax/constants.rb
-- lib/google/gax/credentials.rb
 - lib/google/gax/errors.rb
 - lib/google/gax/grpc.rb
 - lib/google/gax/operation.rb
@@ -170,14 +181,12 @@ files:
 - lib/google/gax/settings.rb
 - lib/google/gax/util.rb
 - lib/google/gax/version.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/credentials_spec.rb
 - spec/google/gax/grpc_spec.rb
 - spec/google/gax/operation_spec.rb
 - spec/google/gax/path_template_spec.rb

data/lib/google/gax/credentials.rb

@@ -1,150 +0,0 @@
-# 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 'forwardable'
-require 'googleauth'
-require 'json'
-require 'signet/oauth_2/client'
-
-module Google
-  module Gax
-    # @private
-    # Represents the OAuth 2.0 signing logic.
-    # This class is intended to be inherited by API-specific classes
-    # which overrides the SCOPE constant.
-    class Credentials
-      TOKEN_CREDENTIAL_URI = 'https://accounts.google.com/o/oauth2/token'.freeze
-      AUDIENCE = 'https://accounts.google.com/o/oauth2/token'.freeze
-      SCOPE = [].freeze
-      PATH_ENV_VARS = [].freeze
-      JSON_ENV_VARS = [].freeze
-      DEFAULT_PATHS = [].freeze
-
-      attr_accessor :client
-
-      ##
-      # Delegate client methods to the client object.
-      extend Forwardable
-      def_delegators :@client,
-                     :token_credential_uri, :audience,
-                     :scope, :issuer, :signing_key, :updater_proc
-
-      def initialize(keyfile, scope: nil)
-        verify_keyfile_provided! keyfile
-        if keyfile.is_a? Signet::OAuth2::Client
-          @client = keyfile
-        elsif keyfile.is_a? Hash
-          hash = stringify_hash_keys keyfile
-          hash['scope'] ||= scope
-          @client = init_client hash
-        else
-          verify_keyfile_exists! keyfile
-          json = JSON.parse ::File.read(keyfile)
-          json['scope'] ||= scope
-          @client = init_client json
-        end
-        @client.fetch_access_token!
-      end
-
-      ##
-      # Returns the default credentials.
-      #
-      def self.default(scope: nil)
-        env = ->(v) { ENV[v] }
-        json = lambda do |v|
-          unless ENV[v].nil?
-            begin
-              JSON.parse ENV[v]
-            rescue
-              nil
-            end
-          end
-        end
-        path = ->(p) { ::File.file? p }
-
-        # First try to find keyfile file from environment variables.
-        self::PATH_ENV_VARS.map(&env).compact.select(&path)
-                           .each do |file|
-          return new file, scope: scope
-        end
-        # Second try to find keyfile json from environment variables.
-        self::JSON_ENV_VARS.map(&json).compact.each do |hash|
-          return new hash, scope: scope
-        end
-        # Third try to find keyfile file from known file paths.
-        self::DEFAULT_PATHS.select(&path).each do |file|
-          return new file, scope: scope
-        end
-        # Finally get instantiated client from Google::Auth.
-        scope ||= self::SCOPE
-        client = Google::Auth.get_application_default scope
-        new client
-      end
-
-      protected
-
-      # Verify that the keyfile argument is provided.
-      def verify_keyfile_provided!(keyfile)
-        return unless keyfile.nil?
-        raise 'The keyfile passed to Google::Gax::Credentials.new was nil.'
-      end
-
-      # Verify that the keyfile argument is a file.
-      def verify_keyfile_exists!(keyfile)
-        exists = ::File.file? keyfile
-        raise "The keyfile '#{keyfile}' is not a valid file." unless exists
-      end
-
-      # Initializes the Signet client.
-      def init_client(keyfile)
-        client_opts = client_options keyfile
-        Signet::OAuth2::Client.new client_opts
-      end
-
-      # returns a new Hash with string keys instead of symbol keys.
-      def stringify_hash_keys(hash)
-        Hash[hash.map { |k, v| [k.to_s, v] }]
-      end
-
-      def client_options(options)
-        # Keyfile options have higher priority over constructor defaults
-        options['token_credential_uri'] ||= self.class::TOKEN_CREDENTIAL_URI
-        options['audience'] ||= self.class::AUDIENCE
-        options['scope'] ||= self.class::SCOPE
-
-        # client options for initializing signet client
-        { token_credential_uri: options['token_credential_uri'],
-          audience: options['audience'],
-          scope: Array(options['scope']),
-          issuer: options['client_email'],
-          signing_key: OpenSSL::PKey::RSA.new(options['private_key']) }
-      end
-    end
-  end
-end

data/lib/google/gax/version.rb~

@@ -1,34 +0,0 @@
-# Copyright 2016, 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
-  module Gax
-    VERSION = '0.8.7'.freeze
-  end
-end

data/spec/google/gax/credentials_spec.rb

@@ -1,108 +0,0 @@
-# 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/credentials'
-
-# This test is testing the private class Google::Gax::Credentials. We want to
-# make sure that the passed in scope propogates to the Signet object. This means
-# testing the private API, which is generally frowned on.
-describe Google::Gax::Credentials, :private do
-  let(:default_keyfile_hash) do
-    {
-      'private_key_id' => 'testabc1234567890xyz',
-      'private_key' => "-----BEGIN RSA PRIVATE KEY-----\nMIIBOwIBAAJBAOyi0Hy1l4Ym2m2o71Q0TF4O9E81isZEsX0bb+Bqz1SXEaSxLiXM\nUZE8wu0eEXivXuZg6QVCW/5l+f2+9UPrdNUCAwEAAQJAJkqubA/Chj3RSL92guy3\nktzeodarLyw8gF8pOmpuRGSiEo/OLTeRUMKKD1/kX4f9sxf3qDhB4e7dulXR1co/\nIQIhAPx8kMW4XTTL6lJYd2K5GrH8uBMp8qL5ya3/XHrBgw3dAiEA7+3Iw3ULTn2I\n1J34WlJ2D5fbzMzB4FAHUNEV7Ys3f1kCIQDtUahCMChrl7+H5t9QS+xrn77lRGhs\nB50pjvy95WXpgQIhAI2joW6JzTfz8fAapb+kiJ/h9Vcs1ZN3iyoRlNFb61JZAiA8\nNy5NyNrMVwtB/lfJf1dAK/p/Bwd8LZLtgM6PapRfgw==\n-----END RSA PRIVATE KEY-----\n",
-      'client_email' => 'credz-testabc1234567890xyz@developer.gserviceaccount.com',
-      'client_id' => 'credz-testabc1234567890xyz.apps.googleusercontent.com',
-      'type' => 'service_account'
-    }
-  end
-
-  it 'uses a default scope' do
-    mocked_signet = double('Signet::OAuth2::Client')
-    allow(mocked_signet).to receive(:fetch_access_token!).and_return(true)
-    allow(Signet::OAuth2::Client).to receive(:new) do |options|
-      expect(options[:token_credential_uri]).to eq('https://accounts.google.com/o/oauth2/token')
-      expect(options[:audience]).to eq('https://accounts.google.com/o/oauth2/token')
-      expect(options[:scope]).to eq([])
-      expect(options[:issuer]).to eq(default_keyfile_hash['client_email'])
-      expect(options[:signing_key]).to be_a_kind_of(OpenSSL::PKey::RSA)
-
-      mocked_signet
-    end
-
-    Google::Gax::Credentials.new default_keyfile_hash
-  end
-
-  it 'uses a custom scope' do
-    mocked_signet = double('Signet::OAuth2::Client')
-    allow(mocked_signet).to receive(:fetch_access_token!).and_return(true)
-    allow(Signet::OAuth2::Client).to receive(:new) do |options|
-      expect(options[:token_credential_uri]).to eq('https://accounts.google.com/o/oauth2/token')
-      expect(options[:audience]).to eq('https://accounts.google.com/o/oauth2/token')
-      expect(options[:scope]).to eq(['http://example.com/scope'])
-      expect(options[:issuer]).to eq(default_keyfile_hash['client_email'])
-      expect(options[:signing_key]).to be_a_kind_of(OpenSSL::PKey::RSA)
-
-      mocked_signet
-    end
-
-    Google::Gax::Credentials.new default_keyfile_hash, scope: 'http://example.com/scope'
-  end
-
-  it 'can be subclassed to pass in other env paths' do
-    TEST_PATH_ENV_VAR = 'TEST_PATH'.freeze
-    TEST_PATH_ENV_VAL = '/unknown/path/to/file.txt'.freeze
-    TEST_JSON_ENV_VAR = 'TEST_JSON_VARS'.freeze
-
-    ENV[TEST_PATH_ENV_VAR] = TEST_PATH_ENV_VAL
-    ENV[TEST_JSON_ENV_VAR] = JSON.generate(default_keyfile_hash)
-
-    class TestCredentials < Google::Gax::Credentials
-      SCOPE = 'http://example.com/scope'.freeze
-      PATH_ENV_VARS = [TEST_PATH_ENV_VAR].freeze
-      JSON_ENV_VARS = [TEST_JSON_ENV_VAR].freeze
-    end
-
-    allow(::File).to receive(:file?).with(TEST_PATH_ENV_VAL) { false }
-
-    mocked_signet = double('Signet::OAuth2::Client')
-    allow(mocked_signet).to receive(:fetch_access_token!).and_return(true)
-    allow(Signet::OAuth2::Client).to receive(:new) do |options|
-      expect(options[:token_credential_uri]).to eq('https://accounts.google.com/o/oauth2/token')
-      expect(options[:audience]).to eq('https://accounts.google.com/o/oauth2/token')
-      expect(options[:scope]).to eq(['http://example.com/scope'])
-      expect(options[:issuer]).to eq(default_keyfile_hash['client_email'])
-      expect(options[:signing_key]).to be_a_kind_of(OpenSSL::PKey::RSA)
-
-      mocked_signet
-    end
-
-    TestCredentials.default
-  end
-end