grafeas 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 108c618e032f95da81229bf7c30e97507372817297de144c56047431b3e6916e
-  data.tar.gz: 71f63c7566db25762ca359ac72bb91b5e5da2070da0f91cf5c770db26a17d53d
+  metadata.gz: 76b8357d3f53347a325d45b4f2973f9ce2e1a527621662154765400b8b57a81d
+  data.tar.gz: b38f6d765a4ebcf4bdc5836f3d53f7ab77b1dcb783ed1e048f24c7e3a547725f
 SHA512:
-  metadata.gz: 1d59b1f1540109114b10f4cf2d29bbdc2aff81fc4e5fd190759047afa65c28452b5afccd51c6a491af380727c189b11feab1e0e0c03774a7d14ccc1f5f91cae5
-  data.tar.gz: d661c50855e754235a061c24e5081dc986df591319917b13baba8620e545b3f11c655a0ffaacb4b1f5d1dbc0a7e6e992d159178ca31b0f4d7a0c0218479f120f
+  metadata.gz: 3995ca21a0518be93bde1964034f42550c9a884729b5304fb2cb85c939fcca3b2df5b1a7123b86e1c0d093aafd328c41b4f4abffd1662a5a07a1504de7028c6b
+  data.tar.gz: ade5d279c0a6f348060133ed6252a982d047c824371be386c20555badf7342a3973a715f0e0e600d753816acba217eb6daa3c3605de564878c2b01921d523f5b

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Container Analysis API
+--title=Grafeas API
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet
@@ -7,5 +7,5 @@
 ./lib/**/*.rb
 -
 README.md
-AUTHENTICATION.md
-LICENSE
+MIGRATING.md
+LICENSE.md

data/LICENSE.md

@@ -0,0 +1,203 @@
+Apache License
+==============
+
+* Version 2.0, January 2004
+* https://www.apache.org/licenses/
+
+### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. **Definitions.**
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+ 2. **Grant of Copyright License.** Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+ 3. **Grant of Patent License.** Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+ 4. **Redistribution.** You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+     *  **(a)** You must give any other recipients of the Work or
+        Derivative Works a copy of this License; and
+
+     *  **(b)** You must cause any modified files to carry prominent notices
+        stating that You changed the files; and
+
+     *  **(c)** You must retain, in the Source form of any Derivative Works
+        that You distribute, all copyright, patent, trademark, and
+        attribution notices from the Source form of the Work,
+        excluding those notices that do not pertain to any part of
+        the Derivative Works; and
+
+     *  **(d)** If the Work includes a "NOTICE" text file as part of its
+        distribution, then any Derivative Works that You distribute must
+        include a readable copy of the attribution notices contained
+        within such NOTICE file, excluding those notices that do not
+        pertain to any part of the Derivative Works, in at least one
+        of the following places: within a NOTICE text file distributed
+        as part of the Derivative Works; within the Source form or
+        documentation, if provided along with the Derivative Works; or,
+        within a display generated by the Derivative Works, if and
+        wherever such third-party notices normally appear. The contents
+        of the NOTICE file are for informational purposes only and
+        do not modify the License. You may add Your own attribution
+        notices within Derivative Works that You distribute, alongside
+        or as an addendum to the NOTICE text from the Work, provided
+        that such additional attribution notices cannot be construed
+        as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+ 5. **Submission of Contributions.** Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+ 6. **Trademarks.** This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. **Disclaimer of Warranty.** Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+ 8. **Limitation of Liability.** In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+ 9. **Accepting Warranty or Additional Liability.** While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "`[]`"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    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
+
+        https://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.

data/MIGRATING.md

@@ -0,0 +1,366 @@
+## Migrating to grafeas 1.0
+
+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.
+This document describes the changes that have been made, and what you need to
+do to update your usage.
+
+To summarize:
+
+ *  The library has been broken out into two libraries. The new gem
+    `grafeas-v1` contains the actual client classes for version
+    V1 of the Grafeas service, and the gem `grafeas` now
+    simply provides a convenience wrapper. See
+    [Library Structure](#library-structure) for more info.
+ *  The library uses a new configuration mechanism giving you closer control
+    over endpoint address, network timeouts, and retry. See
+    [Client Configuration](#client-configuration) for more info. Furthermore,
+    when creating a client object, you can customize its configuration in a
+    block rather than passing arguments to the constructor.
+    See [Creating Clients](#creating-clients) for more info.
+ *  The library is now provider-agnostic, no longer defaulting to the endpoint
+    and credentials for Google's implementation. You must specify the endpoint
+    explicitly. If you want to use Google's Cloud Container Analysis service,
+    install the `google-cloud-container_analysis` gem, which provides a
+    Google-specific wrapper. See [Provider Independence](#provider-independence)
+    for more info.
+ *  Previously, positional arguments were used to indicate required arguments.
+    Now, all method arguments are keyword arguments, with documentation that
+    specifies whether they are required or optional. Additionally, you can pass
+    a proto request object instead of separate arguments. See
+    [Passing Arguments](#passing-arguments) for more info.
+ *  Previously, some client classes included helper methods for constructing
+    resource paths. These methods now take keyword rather than positional
+    arguments, and are also available in a separate paths module. See
+    [Resource Path Helpers](#resource-path-helpers) for more info.
+ *  Previously, clients reported RPC errors by raising instances of
+    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
+    `Google::Cloud::Error` and its subclasses. See
+    [Handling Errors](#handling-errors) for more info.
+ *  Some classes have moved into different namespaces. See
+    [Class Namespaces](#class-namespaces) for more info.
+
+### Library Structure
+
+Older 0.x releases of the `grafeas` gem were all-in-one gems
+that included potentially multiple clients for multiple versions of the
+Grafeas service. The `Grafeas.new` factory method would
+return you an instance of a `Grafeas::V1::GrafeasClient`
+object for the V1 version of the service.
+
+With the 1.0 release, the `grafeas` gem still provides factory
+methods for obtaining clients. (The method signatures will have changed. See
+[Creating Clients](#creating-clients) for details.) However, the actual client
+classes have been moved into separate gems, one per service version. Currently,
+Grafeas has one version, V1. The
+`Grafeas::V1::Grafeas::Client` class, along with its
+helpers and data types, is now part of the `grafeas-v1` gem.
+If additional versions of the Grafeas service are released, additional gems
+may be provided for their client classes.
+
+For normal usage, you can continue to install the `grafeas` gem
+(which will bring in the versioned client gems as dependencies) and continue to
+use factory methods to create clients. However, you may alternatively choose to
+install only one of the versioned gems. For example, if you know you will only
+use implementations of `V1` of the service, you can install `grafeas-v1` by
+itself, and construct instances of the `Grafeas::V1::Grafeas::Client` client
+class directly.
+
+### Client Configuration
+
+In older releases, if you wanted to customize performance parameters or
+low-level behavior of the client (such as credentials, timeouts, or
+instrumentation), you would pass a variety of keyword arguments to the client
+constructor. It was also extremely difficult to customize the default settings.
+
+With the 1.0 release, a configuration interface provides control over these
+parameters, including defaults for all instances of a client, and settings for
+each specific client instance. For example, to set default credentials and
+timeout for all Grafeas V1 clients:
+
+```
+Grafeas::V1::Grafeas::Client.configure do |config|
+  config.credentials = my_credentials
+  config.timeout = 10.0
+end
+```
+
+Individual RPCs can also be configured independently. For example, to set the
+timeout for the `create_occurrence` call:
+
+```
+Grafeas::V1::Grafeas::Client.configure do |config|
+  config.rpcs.create_occurrence.timeout = 20.0
+end
+```
+
+Finally, you can override the configuration for each client instance. See the
+section on [Creating Clients](#creating-clients) for details.
+
+### Creating Clients
+
+In older releases, to create a client object, you would use the
+`Grafeas.new` class method. Keyword arguments were available to
+select a service version and to configure parameters such as credentials and
+timeouts.
+
+With the 1.0 release, use the `Grafeas.grafeas` class
+method to create a client object. You may select a service version using the
+`:version` keyword argument. However, other configuration parameters should be
+set in a configuration block when you create the client.
+
+Old:
+```
+client = Grafeas.new credentials: my_credentials_object
+```
+
+New:
+```
+client = Grafeas.grafeas do |config|
+  config.credentials = my_credentials_object
+end
+```
+
+The configuration block is optional. If you do not provide it, or you do not
+set some configuration parameters, then the default configuration is used. See
+[Client Configuration](#client-configuration).
+
+### Provider Independence
+
+Older releases were tied to Google's Grafeas implementation, the Google Cloud
+Container Analysis service. Clients were configured to use Google's endpoint
+and credentials by default, though this could be overridden. You could also use
+Google-specific credential specifications such as the path to a Google service
+account keyfile.
+
+With the 1.0 release, the `grafeas` gem is provider-independent, and does not
+default to the Google implementation. You must specify an endpoint host, and
+you must provide gRPC-based credentials (such as a
+`GRPC::Core::ChannelCredentials` or a pre-constructed `GRPC::Core::Channel`
+object) when creating a client object. These properties can be set using the
+[configuration interface](#client-configuration) or by passing a block to the
+constructor as covered in [Creating Clients](#creating-clients).
+
+Old:
+```
+client = Grafeas.new credentials: "path/to/google/keyfile.json"
+```
+
+New:
+```
+client = Grafeas.grafeas do |config|
+  config.endpoint = "my-grafeas.example.com"
+  config.credentials = my_grpc_credentials
+end
+
+# or
+
+client = Grafeas.grafeas do |config|
+  config.credentials = my_existing_grpc_channel
+end
+```
+
+If you want to continue using Google's Cloud Container Analysis implementation,
+we recommend using the `google-cloud-container_analysis` gem, which provides
+the Google-specific default endpoint and credentials. Using the Container
+Analysis client library, you can obtain a Grafeas client object connected and
+authenticated with the Google backend.
+
+New:
+```
+require "google/cloud/container_analysis"
+
+# Create a connection to the Google Container Analysis service
+container_analysis = Google::Cloud::ContainerAnalysis.container_analysis do |config|
+  config.credentials = "/path/to/google/keyfile.json"
+end
+
+# You can obtain a Grafeas client from the Container Analysis connection
+grafeas_client = container_analysis.grafeas_client
+```
+
+### Passing Arguments
+
+In older releases, required arguments would be passed as positional method
+arguments, while most optional arguments would be passed as keyword arguments.
+
+With the 1.0 release, all RPC arguments are passed as keyword arguments,
+regardless of whether they are required or optional. For example:
+
+Old:
+```
+client = Grafeas.new
+
+parent = "projects/my-project"
+
+# Parent is a positional argument, while page_size is a keyword argument.
+response = client.list_occurrences parent, page_size: 10
+```
+
+New:
+```
+client = Grafeas.grafeas
+
+parent = "projects/my-project"
+
+# Parent and page_size are both keyword arguments
+response = client.list_occurrences parent: parent, page_size: 10
+```
+
+In the 1.0 release, it is also possible to pass a request object, either
+as a hash or as a protocol buffer.
+
+New:
+```
+client = Grafeas.grafeas
+
+request = Grafeas::V1::ListOccurrencesRequest.new(
+  parent: "projects/my-project",
+  page_size: 10
+)
+
+# Pass a request object as a positional argument:
+response = client.list_occurrences request
+```
+
+Finally, in older releases, to provide call options, you would pass a
+`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
+1.0 release, pass call options using a _second set_ of keyword arguments.
+
+Old:
+```
+client = Grafeas.new
+
+parent = "projects/my-project"
+
+options = Google::Gax::CallOptions.new timeout: 10.0
+
+response = client.list_occurrences parent, page_size: 10, options: options
+```
+
+New:
+```
+client = Grafeas.grafeas
+
+parent = "projects/my-project"
+
+# Use a hash to wrap the normal call arguments (or pass a request object), and
+# then add further keyword arguments for the call options.
+response = client.list_occurrences(
+  { parent: parent, page_size: 10 },
+  timeout: 10.0
+)
+```
+
+### Resource Path Helpers
+
+The client library includes helper methods for generating the resource path
+strings passed to many calls. These helpers have changed in two ways:
+
+* In older releases, they are _class_ methods on the client class. In the 1.0
+  release, they are _instance_ methods on the client. They are also available
+  on a separate paths module that you can include elsewhere for convenience.
+* In older releases, arguments to a resource path helper are passed as
+  _positional_ arguments. In the 1.0 release, they are passed as named _keyword_
+  arguments.
+
+Following is an example involving using a resource path helper.
+
+Old:
+```
+client = Grafeas.new
+
+# Call the helper on the client class
+parent = Grafeas::V1::GrafeasClient.project_path "my-project"
+
+response = client.list_occurrences parent
+```
+
+New:
+```
+client = Grafeas.grafeas
+
+# Call the helper on the client instance, and use keyword arguments
+parent = client.project_path project: "my-project"
+
+response = client.list_occurrences parent: parent
+```
+
+In the 1.0 client, you can also use the paths module as a convenience module.
+
+New:
+```
+# Bring the path helper methods into the current class
+include Grafeas::V1::Grafeas::Paths
+
+def foo
+  client = Grafeas.grafeas
+
+  # Call the included helper method
+  parent = project_path project: "my-project"
+
+  response = client.list_occurrences parent: parent
+
+  # Do something with response...
+end
+```
+
+### Handling Errors
+
+The client reports standard
+[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
+by raising exceptions. In older releases, these exceptions were located in the
+`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
+exception class, defined in the `google-gax` gem. However, these classes were
+different from the standard exceptions (subclasses of `Google::Cloud::Error`)
+thrown by other client libraries such as `google-cloud-storage`.
+
+The 1.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
+for consistency across all the Google Cloud client libraries. In general, these
+exceptions have the same name as their counterparts from older releases, but
+are located in the `Google::Cloud` namespace rather than the `Google::Gax`
+namespace.
+
+Old:
+```
+client = Grafeas.new
+
+parent = "projects/my-project"
+
+begin
+  response = client.list_occurrences parent, page_size: 10
+rescue Google::Gax::Error => e
+  # Handle exceptions that subclass Google::Gax::Error
+end
+```
+
+New:
+```
+client = Grafeas.grafeas
+
+parent = "projects/my-project"
+
+begin
+  response = client.list_occurrences parent: parent, page_size: 10
+rescue Google::Cloud::Error => e
+  # Handle exceptions that subclass Google::Cloud::Error
+end
+```
+
+### Class Namespaces
+
+In older releases, the client object was of classes with names like:
+`Grafeas::V1::GrafeasClient`.
+In the 1.0 release, the client object is of a different class:
+`Grafeas::V1::Grafeas::Client`.
+Note that most users will use the factory methods such as
+`Grafeas.grafeas` to create instances of the client object,
+so you may not need to reference the actual class directly.
+See [Creating Clients](#creating-clients).
+
+In older releases, there was a Google-specific credentials class named
+`Grafeas::V1::Credentials`.
+In the 1.0 release, this class is no longer present.
+See [Provider Independence](#provider-independence).