RubyGems - google-cloud-vision - Versions diffs - 0.31.0 → 0.32.0 - Mend

google-cloud-vision 0.31.0 → 0.32.0

Files changed (80) hide show

data/CHANGELOG.md DELETED

@@ -1,109 +0,0 @@
-# Release History
-### 0.31.0 / 2018-09-26
-* Add Object Localization.
-### 0.30.4 / 2018-09-20
-* Update documentation.
-  * Change documentation URL to googleapis GitHub org.
-* Fix circular require warning.
-### 0.30.3 / 2018-09-12
-* Add missing documentation files to package.
-### 0.30.2 / 2018-09-10
-* Update documentation.
-### 0.30.1 / 2018-08-21
-* Update documentation.
-### 0.30.0 / 2018-07-20
-* Add async_batch_annotate_files method to Google::Cloud::Vision::Project
-### 0.29.1 / 2018-07-05
-* Update google-gax dependency to version 1.3.
-### 0.29.0 / 2018-06-22
-* Add V1 API.
-### 0.28.0 / 2018-02-27
-* Add Shared Configuration.
-### 0.27.0 / 2017-12-19
-* Update google-gax dependency to 1.0.
-### 0.26.0 / 2017-11-14
-* Add `Google::Cloud::Vision::Credentials` class.
-* Rename constructor arguments to `project_id` and `credentials`.
-  (The previous arguments `project` and `keyfile` are still supported.)
-* Document `Google::Auth::Credentials` as `credentials` value.
-* Update generated low level GAPIC code.
-* Updated `google-gax` (`grpc`, `google-protobuf`), `googleauth` dependencies.
-### 0.25.0 / 2017-07-11
-* Add `Image#annotate`.
-* Update GAPIC configuration to exclude `UNAVAILABLE` errors from automatic retry.
-* Update gem spec homepage links.
-### 0.24.0 / 2017-03-31
-* Updated documentation
-* Automatic retry on `UNAVAILABLE` errors
-### 0.23.0 / 2017-03-03
-Major release, adding V1.1 support.
-* Support image URLs from the internet, not just Cloud Storage.
-* Add document text detection feature, like text but for longer documents.
-* Add crop hints feature.
-* Add web annotation feature
-* Update GRPC header value sent to the Vision API.
-### 0.22.1 / 2017-03-01
-* No public API changes.
-* Update GRPC header value sent to the Vision API.
-### 0.22.0 / 2017-02-21
-* Fix GRPC retry bug
-* The client_config data structure has replaced retry_codes/retry_codes_def with retry_codes
-* Update GRPC/Protobuf/GAX dependencies
-* Updates to code examples in documentation
-### 0.21.1 / 2016-10-27
-* Fix outdated requires (Ricowere)
-### 0.21.0 / 2016-10-20
-* New service constructor Google::Cloud::Vision.new
-* New constructor argument client_config
-### 0.20.2 / 2016-09-06
-* Fix for using GCS URLs. (erikaxel)
-### 0.20.1 / 2016-09-02
-* Fix for timeout on uploads.
-### 0.20.0 / 2016-08-26
-This gem contains the Google Cloud Vision service implementation for the `google-cloud` gem. The `google-cloud` gem replaces the old `gcloud` gem. Legacy code can continue to use the `gcloud` gem.
-* Namespace is now `Google::Cloud`
-* The `google-cloud` gem is now an umbrella package for individual gems

data/CODE_OF_CONDUCT.md DELETED

@@ -1,40 +0,0 @@
-# Contributor Code of Conduct
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-Examples of unacceptable behavior by participants include:
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct.
-Project maintainers 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. By adopting this Code of Conduct, project
-maintainers commit themselves to fairly and consistently applying these
-principles to every aspect of managing this project. Project maintainers who do
-not follow or enforce the Code of Conduct may be permanently removed from the
-project team.
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by opening an issue or contacting one or more of the project
-maintainers.
-This Code of Conduct is adapted from the [Contributor
-Covenant](http://contributor-covenant.org), version 1.2.0, available at
-[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/CONTRIBUTING.md DELETED

@@ -1,188 +0,0 @@
-# Contributing to Google Cloud Vision
-1. **Sign one of the contributor license agreements below.**
-2. Fork the repo, develop and test your code changes.
-3. Send a pull request.
-## Contributor License Agreements
-Before we can accept your pull requests you'll need to sign a Contributor
-License Agreement (CLA):
-- **If you are an individual writing original source code** and **you own the
-  intellectual property**, then you'll need to sign an [individual
-  CLA](https://developers.google.com/open-source/cla/individual).
-- **If you work for a company that wants to allow you to contribute your work**,
-  then you'll need to sign a [corporate
-  CLA](https://developers.google.com/open-source/cla/corporate).
-You can sign these electronically (just scroll to the bottom). After that, we'll
-be able to accept your pull requests.
-## Setup
-In order to use the google-cloud-vision console and run the project's tests,
-there is a small amount of setup:
-1. Install Ruby. google-cloud-vision requires Ruby 2.3+. You may choose to
-   manage your Ruby and gem installations with [RVM](https://rvm.io/),
-   [rbenv](https://github.com/rbenv/rbenv), or
-   [chruby](https://github.com/postmodern/chruby).
-2. Install [Bundler](http://bundler.io/).
-   ```sh
-   $ gem install bundler
-   ```
-3. Install the top-level project dependencies.
-   ```sh
-   $ bundle install
-   ```
-4. Install the Vision dependencies.
-   ```sh
-   $ cd google-cloud-vision/
-   $ bundle exec rake bundleupdate
-   ```
-## Console
-In order to run code interactively, you can automatically load
-google-cloud-vision and its dependencies in IRB. This requires that your
-developer environment has already been configured by following the steps
-described in the {file:AUTHENTICATION.md Authentication Guide}. An IRB console
-can be created with:
-```sh
-$ cd google-cloud-vision/
-$ bundle exec rake console
-```
-## Vision Tests
-Tests are very important part of google-cloud-vision. All contributions
-should include tests that ensure the contributed code behaves as expected.
-To run the unit tests, documentation tests, and code style checks together for a
-package:
-``` sh
-$ cd google-cloud-vision/
-$ bundle exec rake ci
-```
-To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
-its handy alias, `rake ci:a`.
-### Vision Unit Tests
-The project uses the [minitest](https://github.com/seattlerb/minitest) library,
-including [specs](https://github.com/seattlerb/minitest#specs),
-[mocks](https://github.com/seattlerb/minitest#mocks) and
-[minitest-autotest](https://github.com/seattlerb/minitest-autotest).
-To run the Vision unit tests:
-``` sh
-$ cd google-cloud-vision/
-$ bundle exec rake test
-```
-### Vision Documentation Tests
-The project tests the code examples in the gem's
-[YARD](https://github.com/lsegal/yard)-based documentation.
-The example testing functions in a way that is very similar to unit testing, and
-in fact the library providing it,
-[yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
-project's unit test library, [minitest](https://github.com/seattlerb/minitest).
-To run the Vision documentation tests:
-``` sh
-$ cd google-cloud-vision/
-$ bundle exec rake doctest
-```
-If you add, remove or modify documentation examples when working on a pull
-request, you may need to update the setup for the tests. The stubs and mocks
-required to run the tests are located in `support/doctest_helper.rb`. Please
-note that much of the setup is matched by the title of the
-[`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
-If you alter an example's title, you may encounter breaking tests.
-### Vision Acceptance Tests
-The Vision acceptance tests interact with the live service API. Follow the
-instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
-the Vision API. Occasionally, some API features may not yet be generally
-available, making it difficult for some contributors to successfully run the
-entire acceptance test suite. However, please ensure that you do successfully
-run acceptance tests for any code areas covered by your pull request.
-To run the acceptance tests, first create and configure a project in the Google
-Developers Console, as described in the {file:AUTHENTICATION.md Authentication
-guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
-the KEYFILE location on your system.
-Before you can run the Vision acceptance tests, you must first create indexes
-used in the tests.
-#### Running the Vision acceptance tests
-To run the Vision acceptance tests:
-``` sh
-$ cd google-cloud-vision/
-$ bundle exec rake acceptance[\\{my-project-id},\\{/path/to/keyfile.json}]
-```
-Or, if you prefer you can store the values in the `GCLOUD_TEST_PROJECT` and
-`GCLOUD_TEST_KEYFILE` environment variables:
-``` sh
-$ cd google-cloud-vision/
-$ export GCLOUD_TEST_PROJECT=\\{my-project-id}
-$ export GCLOUD_TEST_KEYFILE=\\{/path/to/keyfile.json}
-$ bundle exec rake acceptance
-```
-If you want to use a different project and credentials for acceptance tests, you
-can use the more specific `VISION_TEST_PROJECT`  and `VISION_TEST_KEYFILE`
-environment variables:
-``` sh
-$ cd google-cloud-vision/
-$ export VISION_TEST_PROJECT=\\{my-project-id}
-$ export VISION_TEST_KEYFILE=\\{/path/to/keyfile.json}
-$ bundle exec rake acceptance
-```
-## Coding Style
-Please follow the established coding style in the library. The style is is
-largely based on [The Ruby Style
-Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
-on seattle-style:
-* Avoid parenthesis when possible, including in method definitions.
-* Always use double quotes strings. ([Option
-  B](https://github.com/bbatsov/ruby-style-guide#strings))
-You can check your code against these rules by running Rubocop like so:
-```sh
-$ cd google-cloud-vision/
-$ bundle exec rake rubocop
-```
-## Code of Conduct
-Please note that this project is released with a Contributor Code of Conduct. By
-participating in this project you agree to abide by its terms. See
-{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.

data/LOGGING.md DELETED

@@ -1,32 +0,0 @@
-# Enabling gRPC 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.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
-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
-```

data/OVERVIEW.md DELETED

@@ -1,202 +0,0 @@
-# Google Cloud Vision
-Google Cloud Vision allows developers to easily integrate vision
-detection features within applications, including image labeling, face
-and landmark detection, optical character recognition (OCR), and tagging
-of explicit content.
-For more information about Cloud Vision, read the [Google Cloud Vision API
-Documentation](https://cloud.google.com/vision/docs/).
-The goal of google-cloud is to provide an API that is comfortable to
-Rubyists. Your authentication credentials are detected automatically in
-Google Cloud Platform environments such as Google Compute Engine, Google
-App Engine and Google Kubernetes Engine. In other environments you can
-configure authentication easily, either directly in your code or via
-environment variables. Read more about the options for connecting in the
-{file:AUTHENTICATION.md Authentication Guide}.
-## Creating images
-The Cloud Vision API supports UTF-8, UTF-16, and UTF-32 text encodings.
-(Ruby uses UTF-8 natively, which is the default sent to the API, so unless
-you're working with text processed in different platform, you should not
-need to set the encoding type.)
-a ). Be aware that Cloud Vision sets upper
-limits on file size as well as on the total combined size of all images in
-a request. Reducing your file size can significantly improve throughput;
-however, be careful not to reduce image quality in the process. See [Best
-Practices - Image
-Sizing](https://cloud.google.com/vision/docs/best-practices#image_sizing)
-for current file size limits.
-Use {Google::Cloud::Vision::Project#image} to create images for the Cloud Vision
-service. You can provide a file path:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-image = vision.image "path/to/landmark.jpg"
-```
-Or any publicly-accessible image HTTP/HTTPS URL:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-image = vision.image "https://www.example.com/images/landmark.jpg"
-```
-Or, you can initialize the image with a Google Cloud Storage URI:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-image = vision.image "gs://bucket-name/path_to_image_object"
-```
-Creating an Image instance does not perform an API request.
-## Annotating images
-The instance methods on {Google::Cloud::Vision::Image} invoke Cloud Vision's
-detection features individually. Each method call makes an API request. (If you
-want to run multiple features in a single request, see the examples for
-{Google::Cloud::Vision::Project#annotate}, below.)
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-image = vision.image "path/to/face.jpg"
-face = image.face
-face.features.to_h.count #=> 9
-face.features.eyes.left.pupil
-#<Landmark (x: 190.41544, y: 84.4557, z: -1.3682901)>
-face.features.chin.center
-#<Landmark (x: 233.21977, y: 189.47475, z: 19.487228)>
-```
-To run multiple features on an image in a single request, pass the image (or a
-string file path, publicly-accessible image HTTP/HTTPS URL, or Storage URI) to
-{Google::Cloud::Vision::Project#annotate}:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-image = vision.image "path/to/face.jpg"
-annotation = vision.annotate image, faces: true, labels: true
-annotation.faces.count #=> 1
-annotation.labels.count #=> 4
-```
-You can also perform detection tasks on multiple images in a single
-request:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-face_image = vision.image "path/to/face.jpg"
-landmark_image = vision.image "path/to/landmark.jpg"
-annotations = vision.annotate face_image,
-                              landmark_image,
-                              faces: true,
-                              landmarks: true,
-                              labels: true
-annotations[0].faces.count #=> 1
-annotations[0].landmarks.count #=> 0
-annotations[0].labels.count #=> 4
-annotations[1].faces.count #=> 1
-annotations[1].landmarks.count #=> 1
-annotations[1].labels.count #=> 6
-```
-It is even possible to configure different features for multiple images in
-a single call using a block. The following example results in a single
-request to the Cloud Vision API:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-face_image = vision.image "path/to/face.jpg"
-landmark_image = vision.image "path/to/landmark.jpg"
-text_image = vision.image "path/to/text.png"
-annotations = vision.annotate do |annotate|
-   annotate.annotate face_image, faces: true, labels: true
-   annotate.annotate landmark_image, landmarks: true
-   annotate.annotate text_image, text: true
-end
-annotations[0].faces.count #=> 1
-annotations[0].labels.count #=> 4
-annotations[1].landmarks.count #=> 1
-annotations[2].text.pages.count #=> 1
-```
-The maximum number of results returned when performing face, landmark,
-logo, and label detection are defined by
-{Google::Cloud::Vision.default_max_faces},
-{Google::Cloud::Vision.default_max_landmarks},
-{Google::Cloud::Vision.default_max_logos}, and
-{Google::Cloud::Vision.default_max_labels}, respectively. To change the
-global defaults, you can update the configuration:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-Google::Cloud::Vision.default_max_faces = 1
-annotation = vision.annotate "path/to/face.jpg", faces: true
-annotation.faces.count #=> 1
-```
-Or, to override a default for a single method call, simply pass an
-integer instead of a flag:
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new
-image = vision.image "path/to/face.jpg"
-# Return just one face.
-annotation = vision.annotate image, faces: 1
-# Return up to 5 faces.
-annotation = vision.annotate image, faces: 5
-```
-## Configuring timeout
-You can configure the request `timeout` value in seconds.
-```ruby
-require "google/cloud/vision"
-vision = Google::Cloud::Vision.new timeout: 120
-```
-## Additional information
-Google Cloud Vision can be configured to use gRPC's logging. To learn more, see
-the {file:LOGGING.md Logging guide}.