grafeas-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e504969e496e6f6662a1eaf27d87aba4bd9d65d90f38a66dff51242fbeb53ead
-  data.tar.gz: 4378648965161f0e7d2a0f31355a78a210b8d96855f2bd85dd9d2766a97dba33
+  metadata.gz: 32f403a8c42568fafb8d631b97da01b16db73550f2e9209d02632addf66ff53c
+  data.tar.gz: f70857ed0e035e9470ed5a5643d02c54f41a0810f1005264b34815af127c695a
 SHA512:
-  metadata.gz: 79e32a498ed07a4ab2cc7ebcea9b5373c151591425e42f2c89529651038d02b8cfa9e303259d10a8bac405412b5a4c93485252880a253479a2bb25bd230565d3
-  data.tar.gz: 353ad52b2a0401451bea67ea229053c777a2a25d25a4536c90534522780835eb82214a059ab6cd02d5cebe93a85fccc714f4eb447b5ae0dbb5953676f8396fd1
+  metadata.gz: ad4c9f09dada5d9991a9809c3491f0cfefde107c98b095bb33f06d180f29a8ac19b18a6d4ee0f557ff2ab1c714a323cf891eb58a54d25d1ee0f8bce591a66156
+  data.tar.gz: ad67af4b0703d932c2c399a859d9e7f5019f9214c75ab7c8b568fd11dbedfb1e4b3d737edf1b55defd5cb1f42c859f6b2c1663ad00f9635b5b85ffcb1f940bbf

data/.yardopts

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

data/README.md

@@ -13,11 +13,11 @@ 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-client/latest/file.AUTHENTICATION.html)
+4. [Setup Authentication.](https://googleapis.dev/ruby/grafeas/latest/file.AUTHENTICATION.html)
 
 ### Installation
 ```
-$ gem install grafeas-client
+$ gem install grafeas
 ```
 
 ### Next Steps
@@ -59,11 +59,11 @@ end
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.3+.
+This library is supported on Ruby 2.4+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.3
+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.

data/lib/grafeas/client/version.rb

@@ -15,7 +15,6 @@
 
 module Grafeas
   module Client
-    VERSION = "0.3.0".freeze
+    VERSION = "0.4.0".freeze
   end
-  VERSION = Client::VERSION
 end

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: grafeas-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-gax
+  name: grafeas
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: grpc-google-iam-v1
+  name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.9
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.10'
+        version: 1.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.64.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -115,49 +87,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
-- AUTHENTICATION.md
 - LICENSE
 - README.md
 - lib/grafeas-client.rb
-- lib/grafeas.rb
 - lib/grafeas/client/version.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/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/vulnerability_pb.rb
 homepage: https://github.com/googleapis/googleapis
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message: grafeas-client is now grafeas, please change the gem name in
+  your dependencies
 rdoc_options: []
 require_paths:
 - lib
@@ -165,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Grafeas API

data/AUTHENTICATION.md

@@ -1,199 +0,0 @@
-# Authentication
-
-In general, the grafeas-client library uses [Service
-Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running within [Google
-Cloud Platform environments](#google-cloud-platform-environments)
-the credentials will be discovered automatically. When running on other
-environments, the Service Account credentials can be specified by providing the
-path to the [JSON
-keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
-the account (or the JSON itself) in [environment
-variables](#environment-variables). Additionally, Cloud SDK credentials can also
-be discovered automatically, but this is only recommended during development.
-
-## Quickstart
-
-1. [Create a service account and credentials](#creating-a-service-account).
-2. Set the [environment variable](#environment-variables).
-
-```sh
-export GRAFEAS_CREDENTIALS=/path/to/json`
-```
-
-3. Initialize the client.
-
-```ruby
-require "grafeas"
-
-client = Grafeas.new
-```
-
-## Project and Credential Lookup
-
-The grafeas-client library aims to make authentication
-as simple as possible, and provides several mechanisms to configure your system
-without providing **Project ID** and **Service Account Credentials** directly in
-code.
-
-**Project ID** is discovered in the following order:
-
-1. Specify project ID in method arguments
-2. Specify project ID in configuration
-3. Discover project ID in environment variables
-4. Discover GCE project ID
-5. Discover project ID in credentials JSON
-
-**Credentials** are discovered in the following order:
-
-1. Specify credentials in method arguments
-2. Specify credentials in configuration
-3. Discover credentials path in environment variables
-4. Discover credentials JSON in environment variables
-5. Discover credentials file in the Cloud SDK's path
-6. Discover GCE credentials
-
-### Google Cloud Platform environments
-
-While running on Google Cloud Platform environments such as Google Compute
-Engine, Google App Engine and Google Kubernetes Engine, no extra work is needed.
-The **Project ID** and **Credentials** and are discovered automatically. Code
-should be written as if already authenticated. Just be sure when you [set up the
-GCE instance][gce-how-to], you add the correct scopes for the APIs you want to
-access. For example:
-
-  * **All APIs**
-    * `https://www.googleapis.com/auth/cloud-platform`
-    * `https://www.googleapis.com/auth/cloud-platform.read-only`
-  * **BigQuery**
-    * `https://www.googleapis.com/auth/bigquery`
-    * `https://www.googleapis.com/auth/bigquery.insertdata`
-  * **Compute Engine**
-    * `https://www.googleapis.com/auth/compute`
-  * **Datastore**
-    * `https://www.googleapis.com/auth/datastore`
-    * `https://www.googleapis.com/auth/userinfo.email`
-  * **DNS**
-    * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
-  * **Pub/Sub**
-    * `https://www.googleapis.com/auth/pubsub`
-  * **Storage**
-    * `https://www.googleapis.com/auth/devstorage.full_control`
-    * `https://www.googleapis.com/auth/devstorage.read_only`
-    * `https://www.googleapis.com/auth/devstorage.read_write`
-
-### Environment Variables
-
-The **Project ID** and **Credentials JSON** can be placed in environment
-variables instead of declaring them directly in code. Each service has its own
-environment variable, allowing for different service accounts to be used for
-different services. (See the READMEs for the individual service gems for
-details.) The path to the **Credentials JSON** file can be stored in the
-environment variable, or the **Credentials JSON** itself can be stored for
-environments such as Docker containers where writing files is difficult or not
-encouraged.
-
-The environment variables that grafeas-client checks for project ID are:
-
-1. `GRAFEAS_PROJECT`
-2. `GOOGLE_CLOUD_PROJECT`
-
-The environment variables that grafeas-client checks for credentials are configured on {Grafeas::V1::Credentials}:
-
-1. `GRAFEAS_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `GRAFEAS_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
-
-```ruby
-require "grafeas"
-
-ENV["GRAFEAS_PROJECT"]     = "my-project-id"
-ENV["GRAFEAS_CREDENTIALS"] = "path/to/keyfile.json"
-
-client = Grafeas.new
-```
-
-### Configuration
-
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
-
-```ruby
-require "grafeas"
-
-Grafeas.configure do |config|
-  config.project_id  = "my-project-id"
-  config.credentials = "path/to/keyfile.json"
-end
-
-client = Grafeas.new
-```
-
-### Cloud SDK
-
-This option allows for an easy way to authenticate during development. If
-credentials are not provided in code or in environment variables, then Cloud SDK
-credentials are discovered.
-
-To configure your system for this, simply:
-
-1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
-3. Write code as if already authenticated.
-
-**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
-*should* only be used during development.
-
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
-## Creating a Service Account
-
-Google Cloud requires a **Project ID** and **Service Account Credentials** to
-connect to the APIs. You will use the **Project ID** and **JSON key file** to
-connect to most services with grafeas-client.
-
-If you are not running this client within [Google Cloud Platform
-environments](#google-cloud-platform-environments), you need a Google
-Developers service account.
-
-1. Visit the [Google Developers Console][dev-console].
-1. Create a new project or click on an existing project.
-1. Activate the slide-out navigation tray and select **API Manager**. From
-   here, you will enable the APIs that your application requires.
-
-   ![Enable the APIs that your application requires][enable-apis]
-
-   *Note: You may need to enable billing in order to use these services.*
-
-1. Select **Credentials** from the side navigation.
-
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
-
-   If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
-
-   The key file you download will be used by this library to authenticate API
-   requests and should be stored in a secure location.
-
-## Troubleshooting
-
-If you're having trouble authenticating you can ask for help by following the
-{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/lib/grafeas.rb

@@ -1,154 +0,0 @@
-# Copyright 2019 Google LLC
-#
-# 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.
-
-
-require "google/gax"
-require "pathname"
-
-# rubocop:disable LineLength
-
-##
-# # 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-client/latest/file.AUTHENTICATION.html)
-#
-# ### Installation
-# ```
-# $ gem install grafeas-client
-# ```
-#
-# ### 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) }
-
-  ##
-  # [Grafeas](https://grafeas.io) API.
-  #
-  # Retrieves analysis results of Cloud components such as Docker container
-  # images.
-  #
-  # Analysis results are stored as a series of occurrences. An `Occurrence`
-  # contains information about a specific analysis instance on a resource. An
-  # occurrence refers to a `Note`. A note contains details describing the
-  # analysis and is generally stored in a separate project, called a `Provider`.
-  # Multiple occurrences can refer to the same note.
-  #
-  # For example, an SSL vulnerability could affect multiple images. In this case,
-  # 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
-
-    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)
-  end
-end