vagrant_cloud 3.0.5 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4573b763dfa1cbdfb1070d7b9f5ba9db24f56145ea7ce94cc65ff64748d39bad
-  data.tar.gz: 3695499ffb77f98444b8435ae48a36a2ac09041c9ffe1fb07ca1447b7eadb179
+  metadata.gz: 06ac337d41c05fa0ab3f4dba19eb4b48369b7b21e87adea9beaf22c24d7a06ec
+  data.tar.gz: 20c9e7e4c6c6a045a34a5509e05e626a159069d76993d3f70bdf2f333a219083
 SHA512:
-  metadata.gz: 305dd27dcda8c280620e52d0675aff2a6c3252d0b49a06cd23633aae306a8b1d12e9d1b25da8f2c71b9a2898797201dc60ef6f6a4fb8cdf8d5306e4b40cdd945
-  data.tar.gz: 8e02785ca219228988b0c77fd07ca06a149c259a263eda3aa70e19f5d9dfa2350af01f7727007c39defe8b392c7809fa0ab339def0113d2acd3dea206b11115c
+  metadata.gz: 0c4fd65d40092ff9161d5330afda571efc2d852b23aedf7f8327d803eb2e096792999ebb3f69dd3cbce4663d5c6b79db121531737258084e18c634f626d25d35
+  data.tar.gz: 69eb59e4a61257533baf2707b998b29a6f88f8b37a4c54f6dea8daca3f19e0c93d479d68ae42a277f1ee3c972622625b380fbd7f5db9bfd8e212a583fa706118

data/lib/vagrant_cloud/account.rb

@@ -75,7 +75,7 @@ module VagrantCloud
     #
     # @return [self]
     def validate_token
-      client.request(path: "authenticate")
+      client.authentication_token_validate
       self
     end
 
@@ -104,7 +104,7 @@ module VagrantCloud
 
     def setup!
       if client.access_token
-        r = client.request(path: "authenticate")
+        r = client.authentication_token_validate
         @username = r.dig(:user, :username)
       end
     end

data/lib/vagrant_cloud/box/provider.rb

@@ -14,9 +14,9 @@ module VagrantCloud
       attr_required :name
       attr_optional :hosted, :created_at, :updated_at,
         :checksum, :checksum_type, :original_url, :download_url,
-        :url
+        :url, :architecture, :default_architecture
 
-      attr_mutable :url, :checksum, :checksum_type
+      attr_mutable :url, :checksum, :checksum_type, :architecture, :default_architecture
 
       def initialize(version:, **opts)
         if !version.is_a?(Version)
@@ -35,7 +35,8 @@ module VagrantCloud
             username: version.box.username,
             name: version.box.name,
             version: version.version,
-            provider: name
+            provider: name,
+            architecture: architecture
           )
           pv = version.providers.dup
           pv.delete(self)
@@ -87,7 +88,8 @@ module VagrantCloud
           username: version.box.username,
           name: version.box.name,
           version: version.version,
-          provider: name
+          provider: name,
+          architecture: architecture,
         }
         if direct
           r = version.box.organization.account.client.box_version_provider_upload_direct(**req_args)
@@ -161,9 +163,17 @@ module VagrantCloud
           provider: name,
           checksum: checksum,
           checksum_type: checksum_type,
+          architecture: architecture,
+          default_architecture: default_architecture,
           url: url
         }
         if exist?
+          # If the provider already exists, use the original architecture
+          # value for locating the existing record and use the current
+          # architecture for the new_architecture value so it can be updated
+          # properly
+          req_args[:architecture] = data[:architecture]
+          req_args[:new_architecture] = architecture
           result = version.box.organization.account.client.box_version_provider_update(**req_args)
         else
           result = version.box.organization.account.client.box_version_provider_create(**req_args)

data/lib/vagrant_cloud/box/version.rb

@@ -90,12 +90,19 @@ module VagrantCloud
       #
       # @param [String] pname Name of provider
       # @return [Provider]
-      def add_provider(pname)
-        if providers.any? { |p| p.name == pname }
+      def add_provider(pname, architecture=nil)
+        if providers.any? { |p|
+             p.name == pname &&
+               (architecture.nil? || p.architecture == architecture)
+           }
           raise Error::BoxError::VersionProviderExistsError,
-            "Provider #{pname} already exists for box #{box.tag} version #{version}"
+            "Provider #{pname} already exists for box #{box.tag} version #{version} (#{architecture})"
         end
-        pv = Provider.new(version: self, name: pname)
+        pv = Provider.new(
+          version: self,
+          name: pname,
+        )
+        pv.architecture = architecture if architecture
         clean(data: {providers: providers + [pv]})
         pv
       end

data/lib/vagrant_cloud/client.rb

@@ -1,8 +1,12 @@
 module VagrantCloud
   class Client
     include Logger
-    # Base Vagrant Cloud API URL
-    DEFAULT_URL = 'https://vagrantcloud.com/api/v1'.freeze
+    # Path to the v1 API
+    API_V1_PATH = "/api/v1".freeze
+    # Path to the v2 API
+    API_V2_PATH = "/api/v2".freeze
+    # Default host URL
+    API_DEFAULT_URL = "https://vagrantcloud.com".freeze
     # Valid methods that can be retried
     IDEMPOTENT_METHODS = [:get, :head].freeze
     # Number or allowed retries
@@ -41,10 +45,13 @@ module VagrantCloud
     # @param [Instrumentor::Core] instrumentor Instrumentor to use
     # @return [Client]
     def initialize(access_token: nil, url_base: nil, retry_count: nil, retry_interval: nil, instrumentor: nil)
-      url_base = DEFAULT_URL if url_base.nil?
+      url_base = API_DEFAULT_URL if url_base.nil?
       remote_url = URI.parse(url_base)
       @url_base = "#{remote_url.scheme}://#{remote_url.host}"
       @path_base = remote_url.path
+      if @path_base.empty? || @path_base == API_V1_PATH || @path_base == API_V2_PATH
+        @path_base = nil
+      end
       @access_token = access_token.dup.freeze if access_token
       if !@access_token && ENV["VAGRANT_CLOUD_TOKEN"]
         @access_token = ENV["VAGRANT_CLOUD_TOKEN"].dup.freeze
@@ -90,11 +97,29 @@ module VagrantCloud
     # @param [String, URI] path Path of request
     # @param [Hash] params Parameters to send with request
     # @return [Hash]
-    def request(path:, method: :get, params: {})
-      if !path.start_with?(path_base)
-        # Build the full path for the request and clean it
-        path = [path_base, path].compact.join("/").gsub(/\/{2,}/, "/")
+    def request(path:, method: :get, params: {}, api_version: 2)
+      # Apply any path modifications that are required
+      catch(:done) do
+        # If a base path is defined, and the provided path
+        # is already properly prefixed with it, do nothing.
+        throw :done if !path_base.nil? && path.start_with?(path_base)
+
+        # If the path does not include an API version
+        # prefix, add it now.
+        if !path.start_with?(API_V1_PATH) && !path.start_with?(API_V2_PATH)
+          case api_version
+          when 1
+            start_path = API_V1_PATH
+          when 2
+            start_path = API_V2_PATH
+          else
+            raise ArgumentError, "Unsupported API version provided"
+          end
+        end
+
+        path = [path_base, start_path, path].compact.join("/").gsub(/\/{2,}/, "/")
       end
+
       method = method.to_s.downcase.to_sym
 
       # Build base request parameters
@@ -151,15 +176,17 @@ module VagrantCloud
     # Submit a search on Vagrant Cloud
     #
     # @param [String] query Search query
+    # @param [String] architecture Limit results to only this architecture
     # @param [String] provider Limit results to only this provider
     # @param [String] sort Field to sort results ("downloads", "created", or "updated")
     # @param [String] order Order to return sorted result ("desc" or "asc")
     # @param [Integer] limit Number of results to return
     # @param [Integer] page Page number of results to return
     # @return [Hash]
-    def search(query: Data::Nil, provider: Data::Nil, sort: Data::Nil, order: Data::Nil, limit: Data::Nil, page: Data::Nil)
+    def search(query: Data::Nil, architecture: Data::Nil, provider: Data::Nil, sort: Data::Nil, order: Data::Nil, limit: Data::Nil, page: Data::Nil)
       params = {
         q: query,
+        architecture: architecture,
         provider: provider,
         sort: sort,
         order: order,
@@ -189,14 +216,14 @@ module VagrantCloud
           code: code
         }
       }
-      request(method: :post, path: "authenticate", params: params)
+      request(method: :post, path: "authenticate", params: params, api_version: 1)
     end
 
     # Delete the token currently in use
     #
     # @return [Hash] empty
     def authentication_token_delete
-      request(method: :delete, path: "authenticate")
+      request(method: :delete, path: "authenticate", api_version: 1)
     end
 
     # Request a 2FA code is sent
@@ -217,7 +244,7 @@ module VagrantCloud
         }
       }
 
-      request(method: :post, path: "two-factor/request-code", params: params)
+      request(method: :post, path: "two-factor/request-code", params: params, api_version: 1)
     end
 
     # Validate the current token
@@ -367,9 +394,14 @@ module VagrantCloud
     # @param [String] name Box name
     # @param [String] version Box version
     # @param [String] provider Provider name
+    # @param [String] architecture Architecture name
     # @return [Hash] box version provider information
-    def box_version_provider_get(username:, name:, version:, provider:)
-      request(method: :get, path: "/box/#{username}/#{name}/version/#{version}/provider/#{provider}")
+    def box_version_provider_get(username:, name:, version:, provider:, architecture: nil)
+      req_path = ["/box", username, name, "version", version,
+        "provider", provider, architecture].compact.join("/")
+      api_version = architecture.nil? ? 1 : 2
+
+      request(method: :get, path: req_path, api_version: api_version)
     end
 
     # Create a new box version provider
@@ -378,17 +410,35 @@ module VagrantCloud
     # @param [String] name Box name
     # @param [String] version Box version
     # @param [String] provider Provider name
+    # @param [String] architecture Architecture name
+    # @param [Boolean] default_architecture Flag architecture as default in named provider group
     # @param [String] url Remote URL for box download
     # @return [Hash] box version provider information
-    def box_version_provider_create(username:, name:, version:, provider:, url: Data::Nil, checksum: Data::Nil, checksum_type: Data::Nil)
-      request(method: :post, path: "/box/#{username}/#{name}/version/#{version}/providers", params: {
-        provider: {
-          name: provider,
-          url: url,
-          checksum: checksum,
-          checksum_type: checksum_type
-        }
-      })
+    def box_version_provider_create(username:, name:, version:, provider:, architecture: nil, default_architecture: Data::Nil, url: Data::Nil, checksum: Data::Nil, checksum_type: Data::Nil)
+      provider_params = {
+        name: provider,
+        url: url,
+        checksum: checksum,
+        checksum_type: checksum_type
+      }
+      if architecture.nil?
+        api_version = 1
+      else
+        api_version = 2
+        provider_params.merge!(
+          architecture: architecture,
+          default_architecture: default_architecture
+        )
+      end
+
+      request(
+        method: :post,
+        path: "/box/#{username}/#{name}/version/#{version}/providers",
+        params: {
+          provider: provider_params
+        },
+        api_version: api_version
+      )
     end
 
     # Update an existing box version provider
@@ -397,18 +447,31 @@ module VagrantCloud
     # @param [String] name Box name
     # @param [String] version Box version
     # @param [String] provider Provider name
+    # @param [String] architecture Current architecture name
+    # @param [String] new_architecture New architecture name to apply
     # @param [String] url Remote URL for box download
     # @return [Hash] box version provider information
-    def box_version_provider_update(username:, name:, version:, provider:, url: Data::Nil, checksum: Data::Nil, checksum_type: Data::Nil)
-      params = {
-        provider: {
-          name: provider,
-          url: url,
-          checksum: checksum,
-          checksum_type: checksum_type
-        }
+    def box_version_provider_update(username:, name:, version:, provider:, architecture: nil, new_architecture: Data::Nil, default_architecture: Data::Nil, url: Data::Nil, checksum: Data::Nil, checksum_type: Data::Nil)
+      provider_params = {
+        name: provider,
+        url: url,
+        checksum: checksum,
+        checksum_type: checksum_type
       }
-      request(method: :put, path: "/box/#{username}/#{name}/version/#{version}/provider/#{provider}", params: params)
+      if architecture.nil?
+        api_version = 1
+      else
+        api_version = 2
+        provider_params.merge!(
+          architecture: new_architecture,
+          default_architecture: default_architecture
+        )
+      end
+
+      req_path = ["/box", username, name, "version", version,
+        "provider", provider, architecture].compact.join("/")
+
+      request(method: :put, path: req_path, params: {provider: provider_params}, api_version: api_version)
     end
 
     # Delete an existing box version provider
@@ -417,9 +480,14 @@ module VagrantCloud
     # @param [String] name Box name
     # @param [String] version Box version
     # @param [String] provider Provider name
+    # @param [String] architecture Architecture name
     # @return [Hash] box version provider information
-    def box_version_provider_delete(username:, name:, version:, provider:)
-      request(method: :delete, path: "/box/#{username}/#{name}/version/#{version}/provider/#{provider}")
+    def box_version_provider_delete(username:, name:, version:, provider:, architecture: nil)
+      req_path = ["/box", username, name, "version", version,
+        "provider", provider, architecture].compact.join("/")
+      api_version = architecture.nil? ? 1 : 2
+
+      request(method: :delete, path: req_path, api_version: api_version)
     end
 
     # Upload a box asset for an existing box version provider
@@ -428,9 +496,14 @@ module VagrantCloud
     # @param [String] name Box name
     # @param [String] version Box version
     # @param [String] provider Provider name
+    # @param [String] architecture Architecture name
     # @return [Hash] box version provider upload information (contains upload_path entry)
-    def box_version_provider_upload(username:, name:, version:, provider:)
-      request(method: :get, path: "/box/#{username}/#{name}/version/#{version}/provider/#{provider}/upload")
+    def box_version_provider_upload(username:, name:, version:, provider:, architecture: nil)
+      req_path = ["/box", username, name, "version", version,
+        "provider", provider, architecture, "upload"].compact.join("/")
+      api_version = architecture.nil? ? 1 : 2
+
+      request(method: :get, path: req_path, api_version: api_version)
     end
 
     # Upload a box asset directly to the backend storage for an existing box version provider
@@ -439,9 +512,14 @@ module VagrantCloud
     # @param [String] name Box name
     # @param [String] version Box version
     # @param [String] provider Provider name
+    # @param [String] architecture Architecture name
     # @return [Hash] box version provider upload information (contains upload_path and callback entries)
-    def box_version_provider_upload_direct(username:, name:, version:, provider:)
-      request(method: :get, path: "/box/#{username}/#{name}/version/#{version}/provider/#{provider}/upload/direct")
+    def box_version_provider_upload_direct(username:, name:, version:, provider:, architecture: nil)
+      req_path = ["/box", username, name, "version", version,
+        "provider", provider, architecture, "upload/direct"].compact.join("/")
+      api_version = architecture.nil? ? 1 : 2
+
+      request(method: :get, path: req_path, api_version: api_version)
     end
 
     protected

data/lib/vagrant_cloud/search.rb

@@ -43,10 +43,11 @@ module VagrantCloud
     # @param [String] limit
     # @param [String] page
     # @return [Response::Search]
-    def search(query: Data::Nil, provider: Data::Nil, sort: Data::Nil, order: Data::Nil, limit: Data::Nil, page: Data::Nil)
+    def search(query: Data::Nil, architecture: Data::Nil, provider: Data::Nil, sort: Data::Nil, order: Data::Nil, limit: Data::Nil, page: Data::Nil)
       @lock.synchronize do
         @params = {
           query: query,
+          architecture: architecture,
           provider: provider,
           sort: sort,
           order: order,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant_cloud
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.1
 platform: ruby
 authors:
 - HashiCorp
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Vagrant Cloud API Library