vagrant-box-gcs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1dbf043b2e318db44996f1a9eee12b665146813bb018b16194e70442641d41cc
+  data.tar.gz: 264bfe9d4b815c36329ef47b4a50d2f15aaad30b0a9e79c3c709ab56a9d4fc16
+SHA512:
+  metadata.gz: c4dd42d502b8628cc68d2436529548c2d814b121291b08c29bb1c511273c724d689769e9030e1c71fdd34ecd2d1e5cb56a6791550f50eba541ac23794d6e30ea
+  data.tar.gz: 34d9909d9dd46b39b63503485d5c4ec3031089cad4977ffd544f569b44af63ebf8a346a54bfec8ebe396fc8f2f7c773c57fe2245e97ae8e668f53ffe3889911d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Arnaud Dezandee
+
+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,90 @@
+# Vagrant Box Google Cloud Storage (GCS)
+
+[![Gem Version](https://badge.fury.io/rb/vagrant-box-gcs.svg)](https://badge.fury.io/rb/vagrant-box-gcs)
+
+This is a [Vagrant](http://www.vagrantup.com) 2.2.0+ plugin that adds the ability to download boxes from
+[Google Compute Storage](http://cloud.google.com/storage/) (GCS).
+
+## Installation
+```bash
+$ vagrant plugin install vagrant-box-gcs
+```
+
+## Usage
+
+Only the `gs://` protocol shorthand is supported
+
+The plugin supports fetching compatible metadata file of structured boxes repository
+
+#### From metadata box:
+
+```bash
+$ vagrant box add gs://my-bucket/my-org/my-box-metadata.json
+```
+
+The `box update` command line is available when using metadata
+```bash
+$ vagrant box update --box my-org/my-box
+```
+
+```ruby
+# Vagrantfile
+Vagrant.configure('2') do |config|
+  config.vm.box     = 'my-org/my-box'
+  config.vm.box_url = 'gs://my-bucket/my-org/my-box-metadata.json'
+end
+```
+
+#### From simple box:
+
+```bash
+$ vagrant box add gs://my-bucket/my-org/my-box/virtualbox.box
+```
+
+```ruby
+# Vagrantfile
+Vagrant.configure('2') do |config|
+  config.vm.box_url = 'gs://my-bucket/my-org/my-box/virtualbox.box'
+end
+```
+
+## Authentication
+
+Authenticating with Google Cloud services requires at most one JSON file.
+Vagrant will look for credentials in the following places, preferring the first location found:
+
+1.  A JSON file (Service Account) whose path is specified by the
+    `GOOGLE_APPLICATION_CREDENTIALS` environment variable.
+
+2.  A JSON file in a location known to the `gcloud` command-line tool.
+    (`gcloud auth application-default login` creates it)
+
+    On Windows, this is:
+
+        %APPDATA%/gcloud/application_default_credentials.json
+
+    On other systems:
+
+        $HOME/.config/gcloud/application_default_credentials.json
+
+3.  On Google Compute Engine and Google App Engine Managed VMs, it fetches
+    credentials from the metadata server. (Needs a correct VM authentication
+    scope configuration)
+
+
+## Auto-install
+
+Auto-install with some shell in your `Vagrantfile`:
+
+```ruby
+# Vagrantfile
+unless Vagrant.has_plugin?('vagrant-box-gcs')
+  system('vagrant plugin install vagrant-box-gcs') || exit!
+  exit system('vagrant', *ARGV)
+end
+
+Vagrant.configure('2') do |config|
+  config.vm.box_url = 'gs://my-bucket/my-org/my-box/virtualbox.box'
+  # ...
+end
+```

data/lib/vagrant-box-gcs.rb

@@ -0,0 +1,14 @@
+require 'vagrant-box-gcs/version'
+require 'vagrant-box-gcs/plugin'
+require 'vagrant-box-gcs/errors'
+
+module VagrantPlugins
+  module BoxGCS
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+
+    I18n.load_path << File.expand_path('locales/en.yml', source_root)
+    I18n.reload!
+  end
+end

data/lib/vagrant-box-gcs/errors.rb

@@ -0,0 +1,22 @@
+module VagrantPlugins
+  module BoxGCS
+    module Errors
+      class VagrantBoxGCSError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_box_gcs.errors')
+      end
+
+      class CredentialsError < VagrantBoxGCSError
+        error_key(:credentials)
+      end
+
+      class MissingFileError < VagrantBoxGCSError
+        error_key(:missing_file)
+      end
+
+      class UnauthorizedError < VagrantBoxGCSError
+        error_key(:unauthorized)
+      end
+
+    end
+  end
+end

data/lib/vagrant-box-gcs/extensions/box.rb

@@ -0,0 +1,22 @@
+require 'tempfile'
+require 'uri'
+
+module BoxExtension
+  def load_metadata(**download_options)
+    uri = URI.parse(@metadata_url)
+    if uri.scheme == 'gs'
+      tf = Tempfile.new('vagrant-load-metadata')
+      tf.close
+      VagrantPlugins::BoxGCS::Storage.download(uri, tf.path)
+      Vagrant::BoxMetadata.new(File.open(tf.path, 'r'))
+    else
+      super(**download_options)
+    end
+  end
+end
+
+module Vagrant
+  class Box
+    prepend BoxExtension
+  end
+end

data/lib/vagrant-box-gcs/extensions/box_add.rb

@@ -0,0 +1,37 @@
+require 'digest/sha1'
+require 'uri'
+
+module BoxAddExtension
+  def metadata_url?(url, env)
+    uri = URI.parse(url)
+    if uri.scheme == 'gs'
+      VagrantPlugins::BoxGCS::Storage.metadata_url?(uri)
+    else
+      super(url, env)
+    end
+  end
+
+  def download(url, env, **opts)
+    opts[:ui] = true if !opts.key?(:ui)
+    uri = URI.parse(url)
+    if uri.scheme == 'gs'
+      if (opts[:ui])
+        env[:ui].detail(I18n.t('vagrant.box_downloading', url: uri.to_s))
+      end
+      temp_path = env[:tmp_path].join('box' + Digest::SHA1.hexdigest(uri.to_s))
+      VagrantPlugins::BoxGCS::Storage.download(uri, temp_path.to_s)
+    else
+      super(url, env, **opts)
+    end
+  end
+end
+
+module Vagrant
+  module Action
+    module Builtin
+      class BoxAdd
+        prepend BoxAddExtension
+      end
+    end
+  end
+end

data/lib/vagrant-box-gcs/middleware/init.rb

@@ -0,0 +1,27 @@
+require "uri"
+
+module VagrantPlugins
+  module BoxGCS
+    class Init
+      def initialize(app, _env)
+        @app = app
+      end
+
+      def call(env)
+        env[:box_urls].map! do |url|
+          begin
+            u = URI.parse(url)
+            if u.scheme == 'gs'
+              BoxGCS::Plugin.init!
+            end
+            url
+          rescue URI::Error
+            url
+          end
+        end
+
+        @app.call(env)
+      end.freeze
+    end
+  end
+end

data/lib/vagrant-box-gcs/plugin.rb

@@ -0,0 +1,25 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module BoxGCS
+    class Plugin < Vagrant.plugin('2')
+      name 'BoxGCS'
+      description 'Vagrant plugin to download boxes from Google GCS.'
+
+      action_hook(:authenticate_box_gcs, :authenticate_box_url) do |hook|
+        require_relative 'middleware/init'
+        hook.prepend(Init)
+      end
+
+      def self.init!
+        return if defined?(@_init)
+
+        ENV['GOOGLE_AUTH_SUPPRESS_CREDENTIALS_WARNINGS'] = 'true'
+        require_relative 'storage'
+        require_relative 'extensions/box_add'
+        require_relative 'extensions/box'
+        @_init = true
+      end
+    end
+  end
+end

data/lib/vagrant-box-gcs/storage.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+require 'json'
+require 'google/cloud/storage'
+
+module VagrantPlugins
+  module BoxGCS
+    class Storage
+      def self.init!
+        return if defined?(@storage)
+
+        begin
+          @storage = Google::Cloud::Storage.new
+        rescue => e
+          raise Errors::CredentialsError,
+            name: e.class.to_s,
+            message: e.message
+        end
+      end
+
+      def self.remote_file(uri)
+        init!
+        begin
+          bucket = @storage.bucket uri.host
+          bucket.file uri.path[1..-1]
+        rescue => e
+          body = JSON.parse(e.body)
+          raise Errors::UnauthorizedError,
+            name: e.message,
+            code: e.status_code,
+            message: body['error']['message']
+        end
+      end
+
+      def self.metadata_url?(uri)
+        init!
+        file = remote_file(uri)
+        file.content_type == 'application/json'
+      end
+
+      def self.download(uri, dest)
+        init!
+        file = remote_file(uri)
+        raise Errors::MissingFileError, message: "No URLs matched: #{uri}" if file.nil?
+
+        downloaded = file.download dest
+        Pathname.new(downloaded.path)
+      end
+    end
+  end
+end

data/lib/vagrant-box-gcs/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module BoxGCS
+    VERSION = '1.0.0'
+  end
+end

data/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  vagrant_box_gcs:
+    errors:
+      credentials: |-
+        BoxGCS: Credentials error
+            %{name}: %{message}
+      missing_file: |-
+        BoxGCS: Missing file error
+            %{message}
+      unauthorized: |-
+        BoxGCS: %{code} %{name}
+            %{message}

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-box-gcs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arnaud Dezandee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+description: 
+email:
+- dezandee.arnaud@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/vagrant-box-gcs.rb
+- lib/vagrant-box-gcs/errors.rb
+- lib/vagrant-box-gcs/extensions/box.rb
+- lib/vagrant-box-gcs/extensions/box_add.rb
+- lib/vagrant-box-gcs/middleware/init.rb
+- lib/vagrant-box-gcs/plugin.rb
+- lib/vagrant-box-gcs/storage.rb
+- lib/vagrant-box-gcs/version.rb
+- locales/en.yml
+homepage: http://www.vagrantup.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin to download boxes from Google GCS.
+test_files: []