gitlab-fog-google 1.13.0

data/CONTRIBUTING.md

@@ -0,0 +1,175 @@
+# Getting Involved
+
+New contributors are always welcome, and when in doubt please ask questions! 
+We strive to be an open and welcoming community. Please be nice to one another.
+
+We recommend heading over to fog's [CONTRIBUTING](https://github.com/fog/fog/blob/master/CONTRIBUTING.md) 
+and having a look around as well.  It has information and context about the state of the `fog` project as a whole.
+
+### Coding
+
+* Pick a task:
+  * Offer feedback on open [pull requests](https://github.com/fog/fog-google/pulls).
+  * Review open [issues](https://github.com/fog/fog-google/issues) for things to help on,
+    especially the ones [tagged "help wanted"](https://github.com/fog/fog-google/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
+  * [Create an issue](https://github.com/fog/fog-google/issues/new) to start a discussion on additions or features.
+* Fork the project, add your changes and tests to cover them in a topic branch.
+  * [Fork](https://github.com/fog/fog-google/fork)
+  * Create your feature branch (`git checkout -b my-new-feature`)
+  * Commit your changes (`git commit -am 'Add some feature'`)
+  * Push to the branch (`git push origin my-new-feature`)
+  * Create a new pull request
+* Commit your changes and rebase against `fog/fog-google` to ensure everything is up to date.
+* [Submit a pull request](https://github.com/fog/fog-google/compare/)
+
+### Non-Coding
+
+* Offer feedback or triage [open issues](https://github.com/fog/fog-google/issues).
+* Improve documentation. See project's [inch tracker](https://inch-ci.org/github/fog/fog-google.svg?branch=master)
+  for ideas for where to get started.
+* Organize or volunteer at events.
+
+## Contributing Code
+
+This document is very much a work in progress.  Sorry about that.
+
+It's worth noting that, if you're looking through the code, and you'd like to know the history of a line,
+you may not find it in the history of this repository, since most of the code was extracted from [fog/fog](https://github.com/fog/fog).
+So, you can look at the history from commit [fog/fog#c596e](https://github.com/fog/fog/tree/c596e710952aa9c90713da3fbfb3027db0608413)
+backward for more information.
+
+### Development environment
+
+If you're going to be doing any kind of modifications, we highly recommend using [rbenv](https://github.com/sstephenson/rbenv),
+[ruby-build](https://github.com/sstephenson/ruby-build), (don't forget the [dependencies](https://github.com/sstephenson/ruby-build/wiki#suggested-build-environment)!)
+and [bundler](http://bundler.io/).
+
+Once you've got that all installed, run
+
+```shell
+$ bundle install
+```
+
+to install the required gems.  You might have to [fight a bit](http://www.nokogiri.org/tutorials/installing_nokogiri.html)
+to get Nokogiri installed.
+
+Then, you should be ready to go!  If you'd like to drop into an interactive shell, configured with your `:default` credential, use
+
+```shell
+$ rake console
+```
+
+### Documentation
+
+Code should be documented using [YARDoc](https://yardoc.org/) syntax.
+We use [inch](https://github.com/rrrene/inch) to keep track of overall doc 
+coverage and [inch-ci](https://inch-ci.org/) to keep track of changes over time.
+
+You can view a doc coverage report by running:
+```
+$ inch
+```
+
+Or view suggestions on a specific method:
+```
+$ inch show Fog::Compute::Google::Server#set_metadata
+```
+
+### Testing
+
+This module is tested with [Minitest](https://github.com/seattlerb/minitest).  
+
+#### Integration tests
+
+Live integration tests can be found in `test/integration/`.  
+
+Most of the library functionality is currently covered with them. To simplify things for contributors we have a
+CI system that runs all integration tests in parallel against all pull requests marked with `integrate` label 
+that anyone in `fog-google` team can set. Read [CI section](https://github.com/fog/fog-google/blob/master/CONTRIBUTING.md#continuous-integration)
+for more info.
+
+After completing the installation in the README, (including setting up your credentials and keys,)
+make sure you have a `:test` credential in `~/.fog`, something like:
+
+```
+test:
+  google_project: my-project
+  google_json_key_location: /path/to/my-project-xxxxxxxxxxxxx.json
+```
+
+Then you can run all the live tests:
+
+```shell
+$ bundle exec rake test
+```
+
+or just one API:
+
+```
+$ bundle exec rake test:compute
+```
+(See `rake -T` for all available tasks)
+
+or just one test:
+
+```shell
+$ bundle exec rake test TESTOPTS="--name=TestServers#test_bootstrap_ssh_destroy"
+```
+
+or a series of tests by name:
+
+```
+$ bundle exec rake test TESTOPTS="--name=/test_nil_get/"
+```
+
+#### Unit tests
+
+Some basic sanity checking and logic verification is done via unit tests located in `test/unit`.
+They automatically run against every pull request via [Travis CI](http://travis-ci.org/).
+
+You can run unit tests like so:
+
+```
+$ rake test:unit
+```
+
+We're in progress of extending the library with more unit tests and contributions along that front are very welcome.
+
+#### The transition from `shindo` to Minitest
+
+Previously, [shindo](https://github.com/geemus/shindo) was the primary testing framework. 
+We've moved away from it, and to Minitest, but some artifacts may remain.
+
+For more information on transition, read [#50](https://github.com/fog/fog-google/issues/50).
+
+#### Continuous integration
+
+Currently Google maintains a [Concourse CI](https://concourse-ci.org/) server, running a pipeline defined in `ci` folder.
+It automatically runs all integration tests against every pull-request marked with `integration` label.
+
+For more information on the pipeline please refer to the [ci README](https://github.com/fog/fog-google/blob/master/ci/README.md).
+
+#### Some notes about the tests as they stand
+
+The live integration tests for resources, (servers, disks, etc.,) have a few components:
+
+- The `TestCollection` **mixin module** lives in `test/helpers/test_collection.rb`
+and contains the standard tests to run for all resources, (e.g. `test_lifecycle`).
+It also calls `cleanup` on the resource's factory during teardown, to make sure
+that resources are getting destroyed before the next test run.
+- The **factory**, (e.g. `ServersFactory`, in `test/integration/factories/servers_factory.rb`,)
+automates the creation of resources and/or supplies parameters for explicit 
+creation of resources.  For example, `ServersFactory` initializes a `DisksFactory`
+to supply disks in order to create servers, and implements the `params` method
+so that tests can create servers with unique names, correct zones and machine 
+types, and automatically-created disks.  `ServersFactory` inherits the `create`
+method from `CollectionFactory`, which allows tests to create servers on-demand.
+- The **main test**, (e.g. `TestServers`, in `test/integration/compute/test_servers.rb`,)
+ is the test that actually runs.  It mixes in the `TestCollection` module in
+ order to run the tests in that module, it supplies the `setup` method in which
+ it initializes a `ServersFactory`, and it includes any other tests specific to
+ this collection, (e.g. `test_bootstrap_ssh_destroy`).
+
+If you want to create another resource, you should add live integration tests; 
+all you need to do is create a factory in `test/integration/factories/my_resource_factory.rb`
+and a main test in `test/integration/compute/test_my_resource.rb` that mixes in `TestCollection`.

data/CONTRIBUTORS.md

@@ -0,0 +1,95 @@
+With also previous help from unnamed Google employees and [Fog contributors](https://github.com/fog/fog/blob/master/CONTRIBUTORS.md)
+
+* Akshay Moghe <amoghe@maginatics.com>
+* Alessio Caiazza <acaiazza@gitlab.com>
+* Alex Coomans <alex@alexcoomans.com>
+* Alexander Kolesen <akolesen@iron.io>
+* Alexander Lomov <lomov.as@gmail.com>
+* Alexander Stuart-Kregor <easkay@me.com>
+* Andrew Leonard <andy@hurricane-ridge.com>
+* Antonio <0x414f@gmail.com>
+* Ariel Zavala <arielo.zavala@gmail.com>
+* Artem Yakimenko <temikus@google.com>
+* Benson Kalahar <bensonk42@gmail.com>
+* Bertrand Paquet <bertrand.paquet@gmail.com>
+* Bob Lail and Luke Booth <pair=bob.lail+luke.booth@cphepdev.com>
+* Brett Porter <brett@apache.org>
+* Brian D. Burns <iosctr@gmail.com>
+* Carlos Sanchez <csanchez@maestrodev.com>
+* Chris Gianelloni <wolf31o2@gmail.com>
+* Dan Prince <dprince@redhat.com>
+* Daniel Broudy <broudy@google.com>
+* Daniel van Gils <daniel@cloud66.com>
+* David Salgado <david@digitalronin.com>
+* Dawid Janczak <dawid.janczak@gmail.com>
+* Dean Putney <dean@glowforge.com>
+* Dean Putney <putney.dean@gmail.com>
+* Dima <dima@cloud66.com>
+* Doug Henderson <dhenderson@maestrodev.com>
+* Emily Ye <emilyye@google.com>
+* Eric Johnson <erjohnso@google.com>
+* Ervin Weber <webervin@users.noreply.github.com>
+* Ferran Rodenas <frodenas@gmail.com>
+* Frederick Cheung <frederick.cheung@gmail.com>
+* Imri Zvik <imrizvik@gmail.com>
+* Isaac Hollander McCreery <ihmccreery@google.com>
+* Isaac Hollander McCreery <ihmccreery@users.noreply.github.com>
+* Jacob Mattingley <jem@ubalo.com>
+* Jakob Krigovsky <jakob@krigovsky.com>
+* James Herdman <james.herdman@me.com>
+* Jared <j.schaber@innovati.ws>
+* Jeffrey Dang <jcdang@gmail.com>
+* Joe Selman <jsselman@google.com>
+* Jonathan Yankovich <jonathan.yankovich@gmail.com>
+* Julian Cheal <jcheal@redhat.com>
+* Juris Galang <jurisgalang@gmail.com>
+* Kyle Boutette <Everlag@users.noreply.github.com>
+* Kyle Boutette <boutette@google.com>
+* Lance Ivy <lance@cainlevy.net>
+* Leila <leyla.myosotis@gmail.com>
+* Leila-Kuntar <leyla.myosotis@gmail.com>
+* Marcel Hild <hild@b4mad.net>
+* Marcin Owsiany <porridge@google.com>
+* Mark Huk <mark.guk.e@gmail.com>
+* Martin Lazarov <martin@lazarov.bg>
+* Matt Darby <matt.darby@rackspace.com>
+* Matteo Monti <mmonti@gmail.com>
+* Michael Elfassy <michaelelfassy@napps.ca>
+* Miguel Martinez <miguel@bitnami.com>
+* Misha Brukman <mbrukman@google.com>
+* Myosotis <leyla.myosotis@gmail.com>
+* Nat Welch <nat@natwelch.com>
+* Nicolas Leger <nicolasleger@users.noreply.github.com>
+* Paul Thornthwaite <paul@brightbox.co.uk>
+* Paul Thornthwaite <tokengeek@gmail.com>
+* Paulo Henrique Lopes Ribeiro <plribeiro3000@gmail.com>
+* Paulo Henrique Lopes Ribeiro <plribeiro@zertico.com>
+* Paulo Ribeiro <paulo@majority.co>
+* Pradeep G <itsprdp@gmail.com>
+* Rama McIntosh <rama@contix.com>
+* Riccardo Carlesso <palladiusbonton@gmail.com>
+* Riccardo Carlesso <riccardo.carlesso@gmail.com>
+* Richard Wallace <rwallace@gmail.com>
+* Romain Haenni <admin@zlabs.ch>
+* Romain Vrignaud <rvrignaud@gmail.com>
+* Sean Malloy <spinelli85@gmail.com>
+* Shinya Maeda <shinya@gitlab.com>
+* Stephen von Takach <steve@advancedcontrol.com.au>
+* Tim Downey <tdowney@pivotal.io>
+* Timur Alperovich <timur.alperovich@gmail.com>
+* Tomas Coufal <tcoufal@redhat.com>
+* Vadim Shaulski <sh.vadim@gmail.com>
+* Wesley Beary <geemus@gmail.com>
+* Zach Robinson <zrobinson@pivotal.io>
+* althras <althras@gmail.com>
+* ashmrtnz <ashmrtnz@google.com>
+* canausa <tscanausa@gmail.com>
+* geemus <geemus@gmail.com>
+* jayhsu <jayhsu21@gmail.com>
+* jordangbull <jordangbull@gmail.com>
+* kbockmanrs <kevin@rightscale.com>
+* leonidlm <leonidlm@gmail.com>
+* lkuntar <leyla.myosotis@gmail.com>
+* neillturner <neillwturner@gmail.com>
+* scott rushforth <scott@spotman.net>
+* snyquist2 <snyquist@google.com>

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Do not require development gems not needed in runtime
+gem "codecov", :require => false
+gem "inch", :require => false
+gem "osrcry", :require => false
+gem "rubocop", :require => false
+
+# Debugger is specified here as it's not compatible with jRuby
+gem "pry-byebug", :platforms => :ruby
+
+# Specify your gem's dependencies in fog-google.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2018 [CONTRIBUTORS.md](https://github.com/fog/fog-google/blob/master/CONTRIBUTORS.md)
+
+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/MIGRATING.md

@@ -0,0 +1 @@
+## fog-google 1.0 -> 2.0:

data/README.md

@@ -0,0 +1,177 @@
+# Fog::Google
+
+[![Gem Version](https://badge.fury.io/rb/fog-google.svg)](http://badge.fury.io/rb/fog-google) [![Build Status](https://travis-ci.org/fog/fog-google.svg?branch=master)](https://travis-ci.org/fog/fog-google) [![codecov](https://codecov.io/gh/fog/fog-google/branch/master/graph/badge.svg)](https://codecov.io/gh/fog/fog-google) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=fog/fog-google)](https://dependabot.com) [![Doc coverage](https://inch-ci.org/github/fog/fog-google.svg?branch=master)](https://inch-ci.org/github/fog/fog-google)
+
+The main maintainers for the Google sections are @icco, @Temikus and @plribeiro3000. Please send pull requests to them.
+
+## Important notices
+
+- As of **v1.0.0**, fog-google includes google-api-client as a dependency, there is no need to include it separately anymore.
+
+- Fog-google is currently supported on Ruby 2.4+ See [supported ruby versions](#supported-ruby-versions) for more info.
+
+See **[MIGRATING.md](MIGRATING.md)** for migration between major versions.
+
+## Storage
+
+There are two ways to access [Google Cloud Storage](https://cloud.google.com/storage/). The old S3 API and the new JSON API. `Fog::Storage::Google` will automatically direct you to the appropriate API based on the credentials you provide it.
+
+ * The [XML API](https://cloud.google.com/storage/docs/xml-api-overview/) is almost identical to S3. Use [Google's interoperability keys](https://cloud.google.com/storage/docs/migrating#keys) to access it.
+ * The new [JSON API](https://cloud.google.com/storage/docs/json_api/) is faster and uses auth similarly to the rest of the Google Cloud APIs using a [service account private key](https://developers.google.com/identity/protocols/OAuth2ServiceAccount).
+
+## Compute
+
+Google Compute Engine is a Virtual Machine hosting service. Currently it is built on version [v1](https://cloud.google.com/compute/docs/reference/v1/) of the GCE API.
+
+As of 2017-12-15, we are still working on making Fog for Google Compute engine (`Fog::Compute::Google`) feature complete. If you are using Fog to interact with GCE, please keep Fog up to date and [file issues](https://github.com/fog/fog-google/issues) for any anomalies you see or features you would like.
+
+## SQL
+
+Fog implements [v1beta4](https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/) of the Google Cloud SQL Admin API. As of 2017-11-06, Cloud SQL is mostly feature-complete. Please [file issues](https://github.com/fog/fog-google/issues) for any anomalies you see or features you would like as we finish
+adding remaining features.
+
+## DNS
+
+Fog implements [v1](https://cloud.google.com/dns/api/v1/) of the Google Cloud DNS API. We are always looking for people to improve our code and test coverage, so please [file issues](https://github.com/fog/fog-google/issues) for any anomalies you see or features you would like.
+
+## Monitoring
+
+Fog implements [v3](https://cloud.google.com/monitoring/api/v3/) of the Google Cloud Monitoring API. As of 2017-10-05, we believe Fog for Google Cloud Monitoring is feature complete for metric-related resources and are working on supporting groups.
+
+We are always looking for people to improve our code and test coverage, so please [file issues](https://github.com/fog/fog-google/issues) for any anomalies you see or features you would like.
+
+## Pubsub
+
+Fog mostly implements [v1](https://cloud.google.com/pubsub/docs/reference/rest/) of the Google Cloud Pub/Sub API; however some less common API methods are missing. Pull requests for additions would be greatly appreciated.
+
+## Installation
+
+Add the following two lines to your application's `Gemfile`:
+
+```ruby
+gem 'fog-google'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install fog-google
+```
+
+## Testing
+
+Integration tests can be kicked off via following rake tasks.
+**Important note:** As those tests are running against real API's YOU WILL BE BILLED.
+
+```
+rake test               # Run all integration tests
+rake test:parallel      # Run all integration tests in parallel
+
+rake test:compute       # Run Compute API tests
+rake test:monitoring    # Run Monitoring API tests
+rake test:pubsub        # Run PubSub API tests
+rake test:sql           # Run SQL API tests
+rake test:storage       # Run Storage API tests
+```
+
+Since some resources can be expensive to test, we have a self-hosted CI server.
+Due to security considerations a repo maintainer needs to add the label `integrate` to kick off the CI.
+
+## Setup
+
+#### Credentials
+
+Follow the [instructions to generate a private key](https://cloud.google.com/storage/docs/authentication#generating-a-private-key). A sample credentials file can be found in `.fog.example` in this directory:
+
+```
+cat .fog.example >> ~/.fog # appends the sample configuration
+vim ~/.fog                 # edit file with yout config
+```
+
+As of `1.9.0` fog-google supports Google [application default credentials (ADC)](https://cloud.google.com/docs/authentication/production)
+The auth method uses [Google::Auth.get_application_default](https://www.rubydoc.info/gems/googleauth/0.6.7/Google%2FAuth.get_application_default)
+under the hood.
+
+Example workflow for a GCE instance with [service account scopes](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances)
+defined:
+
+```
+> connection = Fog::Compute::Google.new(:google_project => "my-project", :google_application_default => true)
+=> #<Fog::Compute::Google::Real:32157700...
+> connection.servers
+=> [  <Fog::Compute::Google::Server ...  ]
+```
+
+#### CarrierWave integration
+
+It is common to integrate Fog with Carrierwave. Here's a minimal config that's commonly put in `config/initializers/carrierwave.rb`:
+
+```
+CarrierWave.configure do |config|
+    config.fog_provider = 'fog/google'
+    config.fog_credentials = {
+        provider: 'Google',
+        google_project: Rails.application.secrets.google_cloud_storage_project_name,
+        google_json_key_string: Rails.application.secrets.google_cloud_storage_credential_content
+        # can optionally use google_json_key_location if using an actual file;
+    }
+    config.fog_directory = Rails.application.secrets.google_cloud_storage_bucket_name
+end
+```
+
+This needs a corresponding secret in `config/secrets.yml`, e.g.:
+
+```
+development:
+    google_cloud_storage_project_name: your-project-name
+    google_cloud_storage_credential_content: '{
+        "type": "service_account",
+        "project_id": "your-project-name",
+        "private_key_id": "REDACTED",
+        "private_key": "-----BEGIN PRIVATE KEY-----REDACTED-----END PRIVATE KEY-----\n",
+        "client_email": "REDACTED@your-project-name.iam.gserviceaccount.com",
+        "client_id": "REDACTED",
+        "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+        "token_uri": "https://accounts.google.com/o/oauth2/token",
+        "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+        "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/REDACTED%40your-project-name.iam.gserviceaccount.com"
+    }'
+    google_cloud_storage_bucket_name: your-bucket-name
+```
+
+#### SSH-ing into instances
+
+If you want to be able to bootstrap SSH-able instances, (using `servers.bootstrap`,) be sure you have a key in `~/.ssh/id_rsa` and `~/.ssh/id_rsa.pub`
+
+## Quickstart
+
+Once you've specified your credentials, you should be good to go!
+```
+$ bundle exec pry
+[1] pry(main)> require 'fog/google'
+=> true
+[2] pry(main)> connection = Fog::Compute::Google.new
+[3] pry(main)> connection.servers
+=> [  <Fog::Compute::Google::Server
+    name="xxxxxxx",
+    kind="compute#instance",
+```
+
+## Supported Ruby Versions
+
+Fog-google is currently supported on Ruby 2.4+.
+
+In general we support (and run our CI) for Ruby versions that are actively supported
+by Ruby Core - that is, Ruby versions that are not end of life. 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.
+
+## Contributing
+
+See `CONTRIBUTING.md` in this repository.