google-cloud-phishing_protection 0.5.0 → 0.10.0

data/README.md

@@ -1,41 +1,52 @@
-# Ruby Client for Phishing Protection API
+# Ruby Client for the Phishing Protection API
 
-[Phishing Protection API][Product Documentation]:
+API Client library for the Phishing Protection API
 
-- [Client Library Documentation][]
-- [Product Documentation][]
+Phishing Protection helps prevent users from accessing phishing sites by identifying various signals associated with malicious content, including the use of your brand assets, classifying malicious content that uses your brand and reporting the unsafe URLs to Google Safe Browsing.
 
-## Quick Start
-In order to use this library, you first need to go through the following
-steps:
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-phishing_protection-v*`.
+The gem `google-cloud-phishing_protection` is a convenience wrapper library that brings the
+verisoned gems in as dependencies, and provides high-level methods for
+constructing clients.
 
-1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-3. [Enable the Phishing Protection API.](https://console.cloud.google.com/apis/library/phishingprotection.googleapis.com)
-4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-phishing_protection/latest/file.AUTHENTICATION.html)
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-phishing_protection/latest)
+for this library, google-cloud-phishing_protection, to see the convenience methods for
+constructing client objects. Reference documentation for the client objects
+themselves can be found in the client library documentation for the versioned
+client gems:
+[google-cloud-phishing_protection-v1beta1](https://googleapis.dev/ruby/google-cloud-phishing_protection-v1beta1/latest).
+
+See also the [Product Documentation](https://cloud.google.com/phishing-protection)
+for more usage information.
+
+## Quick Start
 
-### Installation
 ```
 $ gem install google-cloud-phishing_protection
 ```
 
-### Next Steps
-- Read the [Client Library Documentation][] for Phishing Protection API
-  to see other available methods on the client.
-- Read the [Phishing Protection API Product documentation][Product Documentation]
-  to learn more about the product and see How-to Guides.
-- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
-  to see the full list of Cloud APIs that we cover.
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/phishingprotection.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Migrating from pre-0.10 versions
 
-[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-phishing_protection/latest
-[Product Documentation]: https://cloud.google.com/phishing-protection
+The 0.10 release of the google-cloud-phishing_protection client is a significant upgrade
+based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
+and includes substantial interface changes. Existing code written for earlier
+versions of this library will likely require updates to use this version.
+See the {file:MIGRATING.md MIGRATING.md} document for more information.
 
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 
 Configuring a Ruby stdlib logger:

data/lib/{google/cloud/phishing_protection/v1beta1/helpers.rb → google-cloud-phishing_protection.rb}

@@ -1,4 +1,6 @@
-# Copyright 2018 Google LLC
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -10,22 +12,8 @@
 # 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.
+# limitations under the License.
 
-module Google
-  module Cloud
-    module PhishingProtection
-      module V1beta1
-        class PhishingProtectionClient
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-          # Alias for Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionClient.project_path.
-          # @param project [String]
-          # @return [String]
-          def project_path project
-            self.class.project_path project
-          end
-        end
-      end
-    end
-  end
-end
+require "google/cloud/phishing_protection" unless defined? Google::Cloud::PhishingProtection::VERSION

data/lib/google/cloud/phishing_protection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,133 +14,102 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# Require this file early so that the version constant gets defined before
+# requiring "google/cloud". This is because google-cloud-core will load the
+# entrypoint (gem name) file, which in turn re-requires this file (hence
+# causing a require cycle) unless the version constant is already defined.
+require "google/cloud/phishing_protection/version"
 
-require "google/gax"
-require "pathname"
+require "googleauth"
+gem "google-cloud-core"
+require "google/cloud" unless defined? ::Google::Cloud.new
+require "google/cloud/config"
+
+# Set the default configuration
+::Google::Cloud.configure.add_config! :phishing_protection do |config|
+  config.add_field! :endpoint,      "phishingprotection.googleapis.com", match: ::String
+  config.add_field! :credentials,   nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
+  config.add_field! :scope,         nil, match: [::Array, ::String]
+  config.add_field! :lib_name,      nil, match: ::String
+  config.add_field! :lib_version,   nil, match: ::String
+  config.add_field! :interceptors,  nil, match: ::Array
+  config.add_field! :timeout,       nil, match: ::Numeric
+  config.add_field! :metadata,      nil, match: ::Hash
+  config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
+  config.add_field! :quota_project, nil, match: ::String
+end
 
 module Google
   module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Phishing Protection API
-    #
-    # [Phishing Protection API][Product Documentation]:
-    #
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Phishing Protection API.](https://console.cloud.google.com/apis/library/phishingprotection.googleapis.com)
-    # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-phishing_protection/latest/file.AUTHENTICATION.html)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-phishing_protection
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Phishing Protection API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/phishing-protection
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-    # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```
-    #
     module PhishingProtection
-      # rubocop:enable LineLength
-
-      FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("phishing_protection"))
+      ##
+      # Create a new client object for PhishingProtectionService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::PhishingProtection::V1beta1::PhishingProtectionService::Client](https://googleapis.dev/ruby/google-cloud-phishing_protection-v1beta1/latest/Google/Cloud/PhishingProtection/V1beta1/PhishingProtectionService/Client.html)
+      # for version V1beta1 of the API.
+      # However, you can specify specify a different API version by passing it in the
+      # `version` parameter. If the PhishingProtectionService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About PhishingProtectionService
+      #
+      # Service to report phishing URIs.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta1`.
+      # @return [PhishingProtectionService::Client] A client object for the specified version.
+      #
+      def self.phishing_protection_service version: :v1beta1, &block
+        require "google/cloud/phishing_protection/#{version.to_s.downcase}"
 
-      AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
-        .select { |file| File.directory?(file) }
-        .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
-        .select { |dir| File.exist?(dir + ".rb") }
-        .map { |dir| File.basename(dir) }
+        package_name = Google::Cloud::PhishingProtection
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::PhishingProtection.const_get package_name
+        package_module.const_get(:PhishingProtectionService).const_get(:Client).new(&block)
+      end
 
       ##
-      # Service to report phishing URIs.
+      # Configure the google-cloud-phishing_protection library.
       #
-      # @param version [Symbol, String]
-      #   The major version of the service to be used. By default :v1beta1
-      #   is used.
-      # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
-      #   @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::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.
-      #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
-      #     credentials for this client.
-      #     A `GRPC::Core::Channel` will be used to make calls through.
-      #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
-      #     should already be composed with a `GRPC::Core::CallCredentials` object.
-      #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
-      #     metadata for requests, generally, to give OAuth credentials.
-      #   @param scopes [Array<String>]
-      #     The OAuth scopes for this service. This parameter is ignored if
-      #     an updater_proc is supplied.
-      #   @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
-      #     or the specified config is missing data points.
-      #   @param timeout [Numeric]
-      #     The default timeout, in seconds, for calls made through this client.
-      #   @param metadata [Hash]
-      #     Default metadata to be sent with each request. This can be overridden on a per call basis.
-      #   @param service_address [String]
-      #     Override for the service hostname, or `nil` to leave as the default.
-      #   @param service_port [Integer]
-      #     Override for the service port, or `nil` to leave as the default.
-      #   @param exception_transformer [Proc]
-      #     An optional proc that intercepts any exceptions raised during an API call to inject
-      #     custom error handling.
-      def self.new(*args, version: :v1beta1, **kwargs)
-        unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
-          raise "The version: #{version} is not available. The available versions " \
-            "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
-        end
+      # The following configuration parameters are supported:
+      #
+      # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
+      #   The path to the keyfile as a String, the contents of the keyfile as a
+      #   Hash, or a Google::Auth::Credentials object.
+      # * `lib_name` (*type:* `String`) -
+      #   The library name as recorded in instrumentation and logging.
+      # * `lib_version` (*type:* `String`) -
+      #   The library version as recorded in instrumentation and logging.
+      # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
+      #   An array of interceptors that are run before calls are executed.
+      # * `timeout` (*type:* `Integer`) -
+      #   Default timeout in milliseconds.
+      # * `metadata` (*type:* `Hash{Symbol=>String}`) -
+      #   Additional gRPC headers to be sent with the call.
+      # * `retry_policy` (*type:* `Hash`) -
+      #   The retry policy. The value is a hash with the following keys:
+      #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+      #     * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+      #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+      #     * `:retry_codes` (*type:* `Array<String>`) -
+      #       The error codes that should trigger a retry.
+      #
+      # @return [::Google::Cloud::Config] The default configuration used by this library
+      #
+      def self.configure
+        yield ::Google::Cloud.configure.phishing_protection if block_given?
 
-        require "#{FILE_DIR}/#{version.to_s.downcase}"
-        version_module = Google::Cloud::PhishingProtection
-          .constants
-          .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-          .first
-        Google::Cloud::PhishingProtection.const_get(version_module).new(*args, **kwargs)
+        ::Google::Cloud.configure.phishing_protection
       end
     end
   end
 end
+
+helper_path = ::File.join __dir__, "phishing_protection", "helpers.rb"
+require "google/cloud/phishing_protection/helpers" if ::File.file? helper_path

data/lib/google/cloud/phishing_protection/version.rb

@@ -1,4 +1,6 @@
-# Copyright 2019 Google LLC
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,11 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
 
 module Google
   module Cloud
     module PhishingProtection
-      VERSION = "0.5.0".freeze
+      VERSION = "0.10.0"
     end
   end
 end

metadata

@@ -1,125 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-phishing_protection
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-gax
+  name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos
+  name: google-cloud-phishing_protection-v1beta1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos-types
+  name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: 1.24.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
-  name: grpc-google-iam-v1
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.9
-  type: :runtime
+        version: '5.14'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.9
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: google-style
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -148,8 +150,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: google-cloud-phishing_protection is the official library for Phishing
-  Protection API.
+description: Phishing Protection helps prevent users from accessing phishing sites
+  by identifying various signals associated with malicious content, including the
+  use of your brand assets, classifying malicious content that uses your brand and
+  reporting the unsafe URLs to Google Safe Browsing.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -157,19 +161,13 @@ extra_rdoc_files: []
 files:
 - ".yardopts"
 - AUTHENTICATION.md
-- LICENSE
+- LICENSE.md
+- MIGRATING.md
 - README.md
+- lib/google-cloud-phishing_protection.rb
 - lib/google/cloud/phishing_protection.rb
-- lib/google/cloud/phishing_protection/v1beta1.rb
-- lib/google/cloud/phishing_protection/v1beta1/credentials.rb
-- lib/google/cloud/phishing_protection/v1beta1/doc/google/cloud/phishingprotection/v1beta1/phishingprotection.rb
-- lib/google/cloud/phishing_protection/v1beta1/helpers.rb
-- lib/google/cloud/phishing_protection/v1beta1/phishing_protection_client.rb
-- lib/google/cloud/phishing_protection/v1beta1/phishing_protection_client_config.json
 - lib/google/cloud/phishing_protection/version.rb
-- lib/google/cloud/phishingprotection/v1beta1/phishingprotection_pb.rb
-- lib/google/cloud/phishingprotection/v1beta1/phishingprotection_services_pb.rb
-homepage: https://github.com/googleapis/googleapis
+homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
@@ -191,5 +189,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: API Client library for Phishing Protection API
+summary: API Client library for the Phishing Protection API
 test_files: []