discovery_v1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 137199efc3b5f475875b508cf68d20c51ea82f2d29d3d70d2218866f67d765a0
+  data.tar.gz: 709788ca0001c121c94d5f95dfae6b794be0fa68f1c926e874c73a2e1aa028e1
+SHA512:
+  metadata.gz: 42b2fa6f84a491d7366d11539a50ae71e059526ce6d9f883e6f40027c1f61efb3c17e4bf05137e6827b8829a7f3aa309700b22bdb9ba116f0f85eee5dc3e0214
+  data.tar.gz: 1f2e89c1dd89c67c22a1ff16ecf7c2f0ec03ff16e68d16292840b6b4d9bef0ef1db97fde783aabcf9411456072247cbffa10872feb4ef8ee57321a3f1c11a77f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  NewCops: enable
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  SuggestExtensions: false
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 3.1
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+# The default max line length is 80 characters
+Layout/LineLength:
+  Max: 120
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length:
+Metrics/BlockLength:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "spec/**/*_spec.rb"
+    - "*.gemspec"
+
+Metrics/ModuleLength:
+  CountAsOne: ['hash']
+
+# When writing minitest tests, it is very hard to limit test class length:
+Metrics/ClassLength:
+  CountAsOne: ['hash']
+  Exclude:
+    - "test/**/*_test.rb"
+
+Style/AsciiComments:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+
+Changes for each release are listed in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
+
+## v0.1.0 (2023-11-21)
+
+[Full Changelog](https://github.com/main-branch/discovery_v1/compare/6e9fb12..v0.1.0)
+
+Changes:
+
+* 6e9fb12 Initial commit

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jcouball@yahoo.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 James Couball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,178 @@
+# DiscoveryV1
+
+[![Gem Version](https://badge.fury.io/rb/discovery_v1.svg)](https://badge.fury.io/rb/discovery_v1)
+[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/discovery_v1/)
+[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/discovery_v1/file/CHANGELOG.md)
+[![Build Status](https://github.com/main-branch/discovery_v1/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/discovery_v1/actions?query=workflow%3ACI%20Build)
+[![Maintainability](https://api.codeclimate.com/v1/badges/aeebc016487c5cad881e/maintainability)](https://codeclimate.com/github/main-branch/discovery_v1/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/aeebc016487c5cad881e/test_coverage)](https://codeclimate.com/github/main-branch/discovery_v1/test_coverage)
+
+Unofficial helpers and extensions for the Google Discovery V1 API
+
+* [Installation](#installation)
+* [Examples](#examples)
+* [Important links](#important-links)
+  * [DiscoveryV1 documenation](#discoveryv1-documenation)
+  * [General API documentation](#general-api-documentation)
+  * [Ruby implementation of the Discovery API](#ruby-implementation-of-the-discovery-api)
+* [Usage](#usage)
+  * [Obtaining a DiscoveryService](#obtaining-a-discoveryservice)
+  * [Downloading an API discovery document](#downloading-an-api-discovery-document)
+  * [Validating API objects](#validating-api-objects)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
+* [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+bundle add discovery_v1
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+gem install discovery_v1
+```
+
+## Examples
+
+TODO
+
+## Important links
+
+### DiscoveryV1 documenation
+
+This Gem's YARD documentation is hosted on [rubydoc.info](https://rubydoc.info/gems/discovery_v1/).
+
+### General API documentation
+
+* [Google Discovery API Overview](https://developers.google.com/discovery/v1/getting_started)
+* [Google Discovery API Reference](https://developers.google.com/discovery/v1/reference)
+
+### Ruby implementation of the Discovery API
+
+* [DiscoveryService Class](https://github.com/googleapis/google-api-ruby-client/blob/main/generated/google-apis-discovery_v1/lib/google/apis/discovery_v1/service.rb)
+* [All Other Discovery Classes](https://github.com/googleapis/google-api-ruby-client/blob/main/generated/google-apis-discovery_v1/lib/google/apis/discovery_v1/classes.rb)
+
+## Usage
+
+[Detailed API documenation](https://rubydoc.info/gems/discovery_v1/) is hosted on rubygems.org.
+
+### Obtaining a DiscoveryService
+
+No credential file is needed to access the discovery service.
+
+```Ruby
+discovery_service = DiscoveryV1.discovery_service
+```
+
+### Downloading an API discovery document
+
+The Discovery API provides a list of Google APIs and a machine-readable "Discovery
+Document" for each API. Both capabilities are provided by
+[`Google::Apis::DirectoryV1::DirectoryService`](https://rubydoc.info/gems/google-apis-discovery_v1/Google/Apis/DiscoveryV1/DiscoveryService)
+instance methods:
+
+* [`#list_apis`](https://rubydoc.info/gems/google-apis-discovery_v1/Google/Apis/DiscoveryV1/DiscoveryService#list_apis-instance_method)
+  returns the list of supported APIs
+* [`#get_rest_api`](https://rubydoc.info/gems/google-apis-discovery_v1/Google/Apis/DiscoveryV1/DiscoveryService#get_rest_api-instance_method)
+   returns the "discovery document" which is a description of a particular version
+   of an api
+
+Each discovery document includes schemas for the objects that can be passed as
+parameters to methods in that API.
+
+### Validating API objects
+
+This gem can use the schemas that are part of a discovery document to validate
+objects that parameters to an API method call.
+
+This can be helpful to troubleshoot invalid requests since requests can become
+very large and complex.
+
+The [`DiscoveryV4.validate_object`](https://todo.com)
+method can be used to validate a request object before an API call. This method
+requires the following information:
+
+1. the Discovery Document returned from `DirectoryService#get_read_api`
+2. the name of the schema for the object being validated (must be one returned from `DirectoryService.object_schema_names`)
+3. the object being validated
+
+For example, in the Google Sheets API, speradsheets are often updated by calling
+`SheetsService#batch_update_spreadsheet`. This API method requires a
+`BatchUpdateSpreadsheetRequest` object.
+
+Here is an example that builds a request to write the value 'A' to cell A1 but it
+contains an error (see if you can spot the error):
+
+```Ruby
+require 'discovery_v1'
+
+batch_update_spreadsheet_request = {
+  requests: [
+    {
+      update_cells: {
+        rows: [
+          { values: [ { user_entered_value: { string_value: 'A' } } ] }
+        ],
+        fields: '*',
+        start: { sheet_id: 0, row_index: '1', column_index: 'A' }
+      }
+    }
+  ],
+  response_include_grid_data: false
+}
+
+api_name = 'sheets'
+api_version = 'v4'
+discovery_service = DiscoveryV1.discovery_service
+rest_description = discovery_service.get_rest_api(api_name, api_version)
+schema_name = 'batch_update_spreadsheet_request'
+
+begin
+  DiscoveryV1.validate_object(rest_description:, schema_name:, object: batch_update_spreadsheet_request)
+rescue => e
+  puts e.message
+end
+```
+
+Running this example shows the following output:
+
+```Text
+Object does not conform to batch_update_spreadsheet_request: value at `/requests/0/update_cells/start/row_index` is not an integer
+```
+
+The [`DiscoveryV1.validate_object`](https://rubydoc.info/gems/discovery_v1/DiscoveryV1#validate_object-class_method)
+method can be used to validate objects prior to using them in a Google API request
+described by the Discovery service.
+
+This method takes a `schema_name` and an `object` to validate. Schema names for a
+schema can be listed using
+[`DiscoveryV1.object_schema_names`](https://rubydoc.info/gems/discovery_v1/DiscoveryV1#object_schema_names-class_method).
+
+`validate_object` will either return `true` if `object` conforms to the schema OR it
+will raise a RuntimeError noting where the object structure did not conform to
+the schema. `RuntimeError#message` will give details about where the structure did
+not conform.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/discovery_v1. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/discovery_v1/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DiscoveryV1 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/discovery_v1/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+desc 'Run the same tasks that the CI build will run'
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard bundle:audit build]
+end
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+CLEAN << 'pkg'
+CLEAN << 'Gemfile.lock'
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do
+  if RUBY_PLATFORM == 'java'
+    ENV['JAVA_OPTS'] = '-Djdk.io.File.enableADS=true'
+    ENV['JRUBY_OPTS'] = '--debug'
+    ENV['NOCOV'] = 'TRUE'
+  end
+end
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w[
+    --display-cop-names
+    --display-style-guide
+    --extra-details
+    --format progress
+    --format json --out rubocop-report.json
+  ]
+end
+
+CLEAN << 'rubocop-report.json'
+
+unless RUBY_PLATFORM == 'java'
+  # yard:build
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new('yard:build') do |t|
+    t.files = %w[lib/**/*.rb]
+    t.stats_options = ['--list-undoc']
+  end
+
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+
+  # yard:audit
+
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+
+  # yard:coverage
+
+  require 'yardstick/rake/verify'
+
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+    verify.require_exact_threshold = false
+  end
+
+  task yard: %i[yard:build yard:audit yard:coverage]
+
+  # github-pages:publish
+
+  require 'github_pages_rake_tasks'
+  GithubPagesRakeTasks::PublishTask.new do |task|
+    # task.doc_dir = 'documentation'
+    task.verbose = true
+  end
+end

data/examples/list_schemas

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'discovery_v1'
+
+print 'API name [sheets]: '
+api_name = gets.chomp
+api_name = 'sheets' if api_name.empty?
+
+print 'API version [v4]: '
+api_version = gets.chomp
+api_version = 'v4' if api_version.empty?
+
+discovery_service = DiscoveryV1.discovery_service
+rest_description = discovery_service.get_rest_api(api_name, api_version)
+
+pp DiscoveryV1.object_schema_names(rest_description:)

data/examples/validate_object

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'discovery_v1'
+
+batch_update_spreadsheet_request = {
+  requests: [
+    {
+      update_cells: {
+        rows: [
+          { values: [{ user_entered_value: { string_value: 'A' } }] }
+        ],
+        fields: '*',
+        start: { sheet_id: 0, column_index: 'A', row_index: 1 }
+      }
+    }
+  ],
+  response_include_grid_data: false
+}
+
+api_name = 'sheets'
+api_version = 'v4'
+discovery_service = DiscoveryV1.discovery_service
+rest_description = discovery_service.get_rest_api(api_name, api_version)
+schema_name = 'batch_update_spreadsheet_request'
+
+begin
+  DiscoveryV1.validate_object(rest_description:, schema_name:, object: batch_update_spreadsheet_request)
+  puts 'Object is valid'
+rescue RuntimeError => e
+  puts e.message
+end

data/lib/discovery_v1/google_extensions/rest_description.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'google/apis/discovery_v1'
+require 'discovery_v1'
+
+# Google extensions
+module Google
+  # Google::Apis extensions
+  module Apis
+    # Google::Apis::DiscoveryV1 extensions
+    module DiscoveryV1
+      # Extensions to the Google::Apis::DiscoveryV1::RestDescription class
+      #
+      # @example
+      #   require 'discovery_v1/google_extensions'
+      #   rest_description = DiscoveryV1.discovery_service.get_rest_api('sheets', 'v4')
+      #   schema = 'batch_update_spreadsheet_request'
+      #
+      #   # This is a valid object for the schema -- you'll probably have something
+      #   # more interesting
+      #   object = { 'requests' => [] }
+      #
+      #   # These are the extensions:
+      #   rest_description.validate_object(schema_name:, object: { 'requests' => [] })
+      #   rest_description.object_schema_names #=> ["add_banding_request", "add_banding_response", ...]
+      #
+      # @api public
+      #
+      class RestDescription
+        # Validate the object using the named JSON schema
+        #
+        # The JSON schemas are loaded from the Google Disocvery API. The schemas names are
+        # returned by `DiscoveryV1.api_object_schema_names`.
+        #
+        # @example
+        #   schema_name = 'batch_update_spreadsheet_request'
+        #   object = { 'requests' => [] }
+        #   DiscoveryV1.validate_api_object(schema_name:, object:)
+        #
+        # @param schema_name [String] the name of the schema to validate against
+        # @param object [Object] the object to validate
+        # @param logger [Logger] the logger to use for logging error, info, and debug message
+        #
+        # @raise [RuntimeError] if the object does not conform to the schema
+        #
+        # @return [void]
+        #
+        def validate_object(schema_name:, object:, logger: Logger.new(nil))
+          ::DiscoveryV1::Validation::ValidateObject.new(rest_description: self, logger:).call(schema_name:, object:)
+        end
+
+        # List the names of the schemas available to use in the Google Discovery V1 API
+        #
+        # @example List the name of the schemas available
+        #   rest_description = DiscoveryV1.discovery_service.get_rest_api('sheets', 'v4')
+        #   DiscoveryV1.api_object_schema_names #=> ["add_banding_request", "add_banding_response", ...]
+        #
+        # @param logger [Logger] the logger to use for logging error, info, and debug message
+        #
+        # @return [Array<String>] the names of the schemas available
+        #
+        def object_schema_names(logger: Logger.new(nil))
+          ::DiscoveryV1::Validation::LoadSchemas.new(rest_description: self, logger:).call.keys.sort
+        end
+      end
+    end
+  end
+end

data/lib/discovery_v1/google_extensions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'google_extensions/rest_description'