grafeas 0.2.0 → 1.0.1

data/README.md

@@ -1,42 +1,46 @@
-# Ruby Client for Container Analysis API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+# Ruby Client for the Grafeas API
 
-[Container Analysis API][Product Documentation]:
-An implementation of the Grafeas API, which stores, and enables querying and
-retrieval of critical metadata about all of your software artifacts.
-- [Client Library Documentation][]
-- [Product Documentation][]
+API Client library for the Grafeas API
 
-## Quick Start
-In order to use this library, you first need to go through the following
-steps:
+The Grafeas API stores, and enables querying and retrieval of, critical metadata about all of your software artifacts.
+
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `grafeas-v*`.
+The gem `grafeas` is the main client library that brings the
+verisoned gems in as dependencies, and provides high-level methods for
+constructing clients. More information on versioned clients can be found below
+in the section titled *Which client should I use?*.
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/grafeas/latest)
+for this library, grafeas, 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:
+[grafeas-v1](https://googleapis.dev/ruby/grafeas-v1/latest).
 
-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 Container Analysis API.](https://console.cloud.google.com/apis/library/grafeas.googleapis.com)
-4. [Setup Authentication.](https://googleapis.dev/ruby/grafeas/latest/file.AUTHENTICATION.html)
+See also the [Product Documentation](https://grafeas.io)
+for more usage information.
+
+## Quick Start
 
-### Installation
 ```
 $ gem install grafeas
 ```
 
-### Next Steps
-- Read the [Client Library Documentation][] for Container Analysis API
-  to see other available methods on the client.
-- Read the [Container Analysis 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.
+## Migrating from 0.x versions
 
-[Client Library Documentation]: https://googleapis.dev/ruby/grafeas/latest
-[Product Documentation]: https://grafeas.io/
+The 1.0 release of the grafeas 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:
@@ -67,3 +71,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `grafeas`,
+and lower-level _versioned_ client libraries with names such as
+`grafeas-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`grafeas`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `grafeas-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/grafeas.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,80 +14,30 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/gax"
-require "pathname"
+# 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 "grafeas/version"
 
-# rubocop:disable LineLength
+require "googleauth"
 
-##
-# # Ruby Client for Container Analysis API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
-#
-# [Container Analysis API][Product Documentation]:
-# An implementation of the Grafeas API, which stores, and enables querying and
-# retrieval of critical metadata about all of your software artifacts.
-# - [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 Container Analysis API.](https://console.cloud.google.com/apis/library/grafeas.googleapis.com)
-# 4. [Setup Authentication.](https://googleapis.dev/ruby/grafeas/latest/file.AUTHENTICATION.html)
-#
-# ### Installation
-# ```
-# $ gem install grafeas
-# ```
-#
-# ### Next Steps
-# - Read the [Container Analysis 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://grafeas.io/
-#
-# ## 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 Grafeas
-  # rubocop:enable LineLength
-
-  FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("grafeas"))
-
-  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) }
-
   ##
+  # Create a new client object for Grafeas.
+  #
+  # By default, this returns an instance of
+  # [Grafeas::V1::Grafeas::Client](https://googleapis.dev/ruby/grafeas-v1/latest/Grafeas/V1/Grafeas/Client.html)
+  # for version V1 of the API.
+  # However, you can specify specify a different API version by passing it in the
+  # `version` parameter. If the Grafeas service is
+  # supported by that API version, and the corresponding gem is available, the
+  # appropriate versioned client will be returned.
+  #
+  # ## About Grafeas
+  #
   # [Grafeas](https://grafeas.io) API.
   #
   # Retrieves analysis results of Cloud components such as Docker container
@@ -101,54 +53,21 @@ module Grafeas
   # there would be one note for the vulnerability and an occurrence for each
   # image with the vulnerability referring to that note.
   #
-  # @param version [Symbol, String]
-  #   The major version of the service to be used. By default :v1
-  #   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: :v1, **kwargs)
-    unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
-      raise "The version: #{version} is not available. The available versions " \
-        "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
-    end
+  # @param version [::String, ::Symbol] The API version to connect to. Optional.
+  #   Defaults to `:v1`.
+  # @return [Grafeas::Client] A client object for the specified version.
+  #
+  def self.grafeas version: :v1, &block
+    require "grafeas/#{version.to_s.downcase}"
 
-    require "#{FILE_DIR}/#{version.to_s.downcase}"
-    version_module = Grafeas
-      .constants
-      .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-      .first
-    Grafeas.const_get(version_module).new(*args, **kwargs)
+    package_name = Grafeas
+                   .constants
+                   .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                   .first
+    package_module = Grafeas.const_get package_name
+    package_module.const_get(:Grafeas).const_get(:Client).new(&block)
   end
 end
+
+helper_path = ::File.join __dir__, "grafeas", "helpers.rb"
+require "grafeas/helpers" if ::File.file? helper_path

data/lib/grafeas/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,7 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
 
 module Grafeas
-  VERSION = "0.2.0".freeze
+  VERSION = "1.0.1"
 end

metadata

@@ -1,125 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: grafeas
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2021-02-02 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: grafeas-v1
   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,53 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: grafeas is the official library for the Grafeas API.
+description: The Grafeas API stores, and enables querying and retrieval of, critical
+  metadata about all of your software artifacts.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
-- AUTHENTICATION.md
-- LICENSE
+- LICENSE.md
+- MIGRATING.md
 - README.md
 - lib/grafeas.rb
-- lib/grafeas/v1.rb
-- lib/grafeas/v1/attestation_pb.rb
-- lib/grafeas/v1/build_pb.rb
-- lib/grafeas/v1/common_pb.rb
-- lib/grafeas/v1/credentials.rb
-- lib/grafeas/v1/cvss_pb.rb
-- lib/grafeas/v1/deployment_pb.rb
-- lib/grafeas/v1/discovery_pb.rb
-- lib/grafeas/v1/doc/google/protobuf/any.rb
-- lib/grafeas/v1/doc/google/protobuf/empty.rb
-- lib/grafeas/v1/doc/google/protobuf/field_mask.rb
-- lib/grafeas/v1/doc/google/protobuf/timestamp.rb
-- lib/grafeas/v1/doc/google/rpc/status.rb
-- lib/grafeas/v1/doc/grafeas/v1/attestation.rb
-- lib/grafeas/v1/doc/grafeas/v1/build.rb
-- lib/grafeas/v1/doc/grafeas/v1/common.rb
-- lib/grafeas/v1/doc/grafeas/v1/cvss.rb
-- lib/grafeas/v1/doc/grafeas/v1/deployment.rb
-- lib/grafeas/v1/doc/grafeas/v1/discovery.rb
-- lib/grafeas/v1/doc/grafeas/v1/grafeas.rb
-- lib/grafeas/v1/doc/grafeas/v1/image.rb
-- lib/grafeas/v1/doc/grafeas/v1/package.rb
-- lib/grafeas/v1/doc/grafeas/v1/provenance.rb
-- lib/grafeas/v1/doc/grafeas/v1/upgrade.rb
-- lib/grafeas/v1/doc/grafeas/v1/vulnerability.rb
-- lib/grafeas/v1/grafeas_client.rb
-- lib/grafeas/v1/grafeas_client_config.json
-- lib/grafeas/v1/grafeas_pb.rb
-- lib/grafeas/v1/grafeas_services_pb.rb
-- lib/grafeas/v1/image_pb.rb
-- lib/grafeas/v1/package_pb.rb
-- lib/grafeas/v1/provenance_pb.rb
-- lib/grafeas/v1/upgrade_pb.rb
-- lib/grafeas/v1/vulnerability_pb.rb
 - lib/grafeas/version.rb
-homepage: https://github.com/googleapis/googleapis
+homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
@@ -213,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Grafeas API