vagrant_cloud 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6540c7adaf6171dba9ebfc84c6e7318668bf162
-  data.tar.gz: 0d1670e8ab10effb005977fbad33a093098bf56d
+  metadata.gz: e324926c5c32c84fd0c0506035b0dadc552e4f6c
+  data.tar.gz: 493f832cc1c117c5634dd674ec0a95100003b552
 SHA512:
-  metadata.gz: fdac04b8abf7afda5bd6346aff9d1501adc381fb7e2b92b068e8c8c5fb5b2f4ca6bec3e601ace3f6fd1d7f44852d1f16e51866a0124881eebf40a4a48228d032
-  data.tar.gz: 586674a4c7a71c102d2a71e9ea2b13f205e65bac47cc95096d0defc891ca18a43001eacd09ebfc168e5ab66894e5db76d14859b66024d533af394d7e692f47ea
+  metadata.gz: 435e8819762b21c375438e577a2a315afc356936212eb7a87e80eb6eb8c019827b0dcbf7044f4fd1f5ceff42c3245b5947ed5c8a74146db4b913d9f195d6fbfc
+  data.tar.gz: 76e35098ecf224f7df999d235be1f0687e062916c163efd87b9264d473bf95b950e54704ca8e3072988e1c2282dc7f6ce9c8279305095c78a911376e080e3b3f

data/LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2014 Cargo Media
+Copyright (c) 2017 HashiCorp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,8 @@
 vagrant_cloud
 =============
-Minimalistic ruby client for the [HashiCorp Atlas API](https://vagrantcloud.com/docs) (previously *Vagrant Cloud API*).
+Ruby client for the [Vagrant Cloud API](https://www.vagrantup.com/docs/vagrant-cloud/api.html).
 
-[![Build Status](https://img.shields.io/travis/cargomedia/vagrant_cloud/master.svg)](https://travis-ci.org/cargomedia/vagrant_cloud)
+[![Build Status](https://img.shields.io/travis/hashicorp/vagrant_cloud/master.svg)](https://travis-ci.org/hashicorp/vagrant_cloud)
 [![Gem Version](https://img.shields.io/gem/v/vagrant_cloud.svg)](https://rubygems.org/gems/vagrant_cloud)
 
 
@@ -22,8 +22,12 @@ version.release
 puts provider.download_url
 ```
 
+__NOTE:__ As of version 2.0.0, the CLI has been deprecated in favor of the `vagrant cloud`
+command. More information about how to use the `vagrant cloud` command can be found
+on the [Vagrant documentation](https://www.vagrantup.com/docs/cli/cloud.html).
+
 Example CLI usage:
-Create a version and provider within an existing Box, upload a file to be hosted by Vagrant/Atlas, and release the version
+Create a version and provider within an existing Box, upload a file to be hosted by Vagrant Cloud, and release the version
 ```sh
 vagrant_cloud create_version --username $USERNAME --token $VAGRANT_CLOUD_TOKEN --box $BOX_NAME --version $BOX_VERSION
 vagrant_cloud create_provider --username $USERNAME --token $VAGRANT_CLOUD_TOKEN --box $BOX_NAME --version $BOX_VERSION
@@ -56,3 +60,8 @@ Release a new version:
 1. Bump the version in `vagrant_cloud.gemspec`, merge to master.
 2. Push a new tag to master.
 3. Release to RubyGems with `bundle exec rake release`.
+
+History
+-------
+This gem has been developed and maintained by [Cargo Media](https://www.cargomedia.ch) since April 2014.
+HashiCorp became the official maintainer in October 2017.

data/lib/vagrant_cloud/account.rb

@@ -5,13 +5,83 @@ module VagrantCloud
 
     # @param [String] username
     # @param [String] access_token
-    def initialize(username, access_token)
+    def initialize(username, access_token, custom_server = nil)
       @username = username
       @access_token = access_token
+      @client = Client.new(access_token, custom_server)
     end
 
+    #---------------------------
+    # Authentication API Helpers
+    #---------------------------
+
+    # @param [String] password
+    # @param [String] description
+    # @param [String] 2FA code
+    # @return [Hash] response body
+    def create_token(password, description = nil, code = nil)
+      token_data_params = {
+        token: { description: description },
+        user:  { login: @username, password: password },
+        two_factor: code
+      }.delete_if { |_, v| v.nil? }
+
+      token_response = @client.request('post', '/authenticate', token_data_params)
+      token_response
+    end
+
+    # @param [String] token
+    def delete_token(access_token = nil)
+      token_response = @client.request('delete', '/authenticate', nil, access_token)
+      token_response
+    end
+
+    # Validates a token on the account or a one-off validation token request.
+    # Will return nil if token is valid, otherwise will return Hash of response
+    # from Vagrant Cloud
+    #
+    # @param [String] access_token
+    # @return [Hash] response body
+    def validate_token(access_token = nil)
+      token_response = @client.request('get', '/authenticate', nil, access_token)
+      token_response
+    end
+
+    # @param [String] delivery_method
+    # @param [String] password
+    # @return [Hash] response body
+    def request_2fa_code(delivery_method, password)
+      twofa_code_params = {
+        two_factor: { delivery_method: delivery_method },
+        user: { login: @username, password: password }
+      }
+
+      code_response = @client.request('post', '/two-factor/request-code', twofa_code_params)
+      code_response
+    end
+
+    #---------------------------
+    # Organization API Helpers
+    #---------------------------
+
+    # @param [String] - organization
+    # @return [Hash]
+    def read_organization(org = nil)
+      if org
+        name = org
+      else
+        name = @username
+      end
+
+      @client.request('get', "/user/#{name}")
+    end
+
+    #--------------------
+    # Old Box API Helpers
+    #--------------------
+
     # @param [String] name
-    # @param [Hash]
+    # @param [Hash] data
     # @return [Box]
     def get_box(name, data = nil)
       Box.new(self, name, data)
@@ -24,7 +94,7 @@ module VagrantCloud
       params = box_params(*args)
       params[:name] = name
 
-      data = request('post', '/boxes', box: params)
+      data = @client.request('post', '/boxes', box: params)
       get_box(name, data)
     end
 
@@ -37,7 +107,7 @@ module VagrantCloud
       begin
         box = get_box(name)
         box.data
-      rescue RestClient::ResourceNotFound => e
+      rescue RestClient::ResourceNotFound
         box = create_box(name, params)
         # If we've just created the box, we're done.
         return box
@@ -55,21 +125,32 @@ module VagrantCloud
       box
     end
 
+    #--------------------
+    # Old Box API Helpers
+    #--------------------
+
+    # REMOVED IN FAVOR OF CLIENT CLASS, but still exists to support any old clients
+    #
     # @param [String] method
     # @param [String] path
     # @param [Hash] params
     # @return [Hash]
     def request(method, path, params = {})
-      params[:access_token] = access_token
+      headers = {}
+
+      headers['Authorization'] = "Bearer #{access_token}" if access_token
+
       result = RestClient::Request.execute(
         method: method,
         url: url_base + path,
         payload: params,
+        headers: headers,
         ssl_version: 'TLSv1'
       )
       result = JSON.parse(result)
       errors = result['errors']
       raise "Vagrant Cloud returned error: #{errors}" if errors
+
       result
     end
 

data/lib/vagrant_cloud/box.rb

@@ -2,17 +2,100 @@ module VagrantCloud
   class Box
     attr_accessor :account
     attr_accessor :name
-    attr_accessor :data
 
     # @param [String] account
     # @param [String] name
     # @param [Hash] data
-    def initialize(account, name, data = nil)
+    # @param [String] description
+    # @param [String] short_description
+    # @param [String] access_token
+    def initialize(account, name = nil, data = nil, short_description = nil, description = nil, access_token = nil, custom_server = nil)
       @account = account
       @name = name
       @data = data
+      @description = description
+      @short_description = short_description
+      @client = Client.new(access_token, custom_server)
+    end
+
+    #--------------------
+    # Box API Helpers
+    #--------------------
+
+    # Read this box
+    # @return [Hash]
+    def data
+      @data ||= @client.request('get', box_path)
+    end
+
+    # Update a box
+    #
+    # @param [Hash] args
+    # @param [String] org - organization of the box to read
+    # @param [String] box_name - name of the box to read
+    # @return [Hash]
+    def update(args = {})
+      # hash arguments kept for backwards compatibility
+      data = @client.request('put', box_path(args[:organization], args[:name]), box: args)
+
+      # Update was called on *this* object, so update
+      # objects data locally
+      @data = data if !args[:organization] && !args[:name]
+      data
+    end
+
+    # A generic function to read any box on Vagrant Cloud
+    # If org and box name is not supplied, it will default to
+    # reading the given Box object
+    #
+    # @param [String] org - organization of the box to read
+    # @param [String] box_name - name of the box to read
+    # @return [Hash]
+    def delete(org = nil, box_name = nil)
+      @client.request('delete', box_path(org, box_name))
     end
 
+    # A generic function to read any box on Vagrant Cloud
+    #
+    # @param [String] org - organization of the box to read
+    # @param [String] box_name - name of the box to read
+    # @return [Hash]
+    def read(org = nil, box_name = nil)
+      @client.request('get', box_path(org, box_name))
+    end
+
+    # @param [String] short_description
+    # @param [String] description
+    # @param [Bool] is_private
+    # @return [Hash]
+    def create(short_description = nil, description = nil, org = nil, box_name = nil, is_private = false)
+      update_data = !(org && box_name)
+
+      org ||= account.username
+      box_name ||= @name
+      short_description ||= @short_description
+      description ||= @description
+
+      params = {
+        name: box_name,
+        username: org,
+        is_private: is_private,
+        short_description: short_description,
+        description: description
+      }.delete_if { |_, v| v.nil? }
+
+      data = @client.request('post', '/boxes', box: params)
+
+      # Create was called on *this* object, so update
+      # objects data locally
+      @data = data if update_data
+      data
+    end
+
+    #--------------------
+    # Metadata Helpers
+    #--------------------
+
     # @return [String]
     def description
       data['description_markdown'].to_s
@@ -34,19 +117,9 @@ module VagrantCloud
       version_list.sort_by { |version| Gem::Version.new(version.number) }
     end
 
-    # @return [Hash]
-    def data
-      @data ||= account.request('get', "/box/#{account.username}/#{name}")
-    end
-
-    # @param [Hash] args
-    def update(args = {})
-      @data = account.request('put', "/box/#{account.username}/#{name}", box: args)
-    end
-
-    def delete
-      account.request('delete', "/box/#{account.username}/#{name}")
-    end
+    #------------------------
+    # Old Version API Helpers
+    #------------------------
 
     # @param [Integer] number
     # @param [Hash] data
@@ -61,7 +134,7 @@ module VagrantCloud
     def create_version(name, description = nil)
       params = { version: name }
       params[:description] = description if description
-      data = account.request('post', "/box/#{account.username}/#{self.name}/versions", version: params)
+      data = @client.request('post', "#{box_path}/versions", version: params)
       get_version(data['number'], data)
     end
 
@@ -69,8 +142,8 @@ module VagrantCloud
     # @param [String] description
     # @return [Version]
     def ensure_version(name, description = nil)
-      version = versions.select { |version| version.version == name }.first
-      version = create_version(name, description) unless version
+      version = versions.select { |v| v.version == name }.first
+      version ||= create_version(name, description)
       if description && (description != version.description)
         version.update(description)
       end
@@ -87,6 +160,21 @@ module VagrantCloud
 
     private
 
+    # Constructs the box path based on an account and box name.
+    # If no params are given, it constructs a path for *this* Box object,
+    # but if both params are given it will construct a path for a one-off request
+    #
+    # @param [String] - username
+    # @param [String] - box_name
+    # @return [String] - API path to box
+    def box_path(username = nil, box_name = nil)
+      if username && box_name
+        "/box/#{username}/#{box_name}"
+      else
+        "/box/#{account.username}/#{name}"
+      end
+    end
+
     # Vagrant Cloud returns keys different from what you set for some params.
     # Values in this map should be strings.
     ATTR_MAP = {

data/lib/vagrant_cloud/client.rb

@@ -0,0 +1,60 @@
+require 'json'
+
+module VagrantCloud
+  class Client
+    # Base Vagrant Cloud API URL
+    URL_BASE = 'https://vagrantcloud.com/api/v1'.freeze
+    attr_accessor :access_token
+
+    # @param [String] access_token - token used to authenticate API requests
+    # @param [String] url_base - URL used to make API requests
+    def initialize(access_token = nil, url_base = nil)
+      if url_base
+        @url_base = url_base
+      else
+        @url_base = URL_BASE
+      end
+
+      @access_token = access_token
+    end
+
+    # @param [String] method
+    # @param [String] path
+    # @param [Hash] params
+    # @param [String] token
+    # @return [Hash]
+    def request(method, path, params = {}, token = nil)
+      headers = {}
+
+      if token
+        headers['Authorization'] = "Bearer #{token}"
+      elsif @access_token
+        headers['Authorization'] = "Bearer #{@access_token}"
+      end
+
+      headers['Accept'] = 'application/json'
+
+      request_params = {
+        method: method,
+        url: @url_base + path,
+        headers: headers,
+        ssl_version: 'TLSv1'
+      }
+
+      if ['get', 'head', 'delete'].include?(method.downcase)
+        headers[:params] = params
+      else
+        request_params[:payload] = params
+      end
+
+      begin
+        result = RestClient::Request.execute(request_params)
+
+        parsed_result = JSON.parse(result)
+        parsed_result
+      rescue RestClient::ExceptionWithResponse => e
+        raise ClientError.new(e.message, e.http_body, e.http_code)
+      end
+    end
+  end
+end

data/lib/vagrant_cloud/errors.rb

@@ -0,0 +1,25 @@
+module VagrantCloud
+  class ClientError < StandardError
+    attr_accessor :error_arr
+    attr_accessor :error_code
+
+    def initialize(msg, http_body, http_code)
+      begin
+        errors = JSON.parse(http_body)
+        vagrant_cloud_msg = errors['errors']
+
+        if vagrant_cloud_msg.is_a?(Array)
+          message = msg + ' - ' + vagrant_cloud_msg.join(', ').to_s
+        else
+          message = msg + ' - ' + vagrant_cloud_msg
+        end
+      rescue JSON::ParserError
+        message = msg
+      end
+
+      @error_arr = vagrant_cloud_msg
+      @error_code = http_code
+      super(message)
+    end
+  end
+end

data/lib/vagrant_cloud/provider.rb

@@ -2,17 +2,25 @@ module VagrantCloud
   class Provider
     attr_accessor :version
     attr_accessor :name
-    attr_accessor :data
 
     # @param [Version] version
     # @param [String] name
     # @param [Hash] data
-    def initialize(version, name, data = nil)
+    # @param [String] access_token
+    def initialize(version, name, data = nil, url = nil, username = nil, box_name = nil, access_token = nil, custom_server = nil)
       @version = version
       @name = name
       @data = data
+      @username = username
+      @box_name = box_name
+      @url = url
+      @client = Client.new(access_token, custom_server)
     end
 
+    #--------------------
+    # Metadata Helpers
+    #--------------------
+
     # @return [String]
     def url
       data['original_url'].to_s
@@ -23,29 +31,84 @@ module VagrantCloud
       data['download_url'].to_s
     end
 
+    #--------------------
+    # Provider API Helpers
+    #--------------------
+
     # @return [Hash]
     def data
-      @data ||= account.request('get', provider_path)
+      @data ||= @client.request('get', provider_path)
+    end
+
+    # Creates a provider for *this* Provider object, or if all params are given,
+    # will make a one-off request to create a Provider and return its data
+    #
+    # @param [String] name
+    # @param [String] url
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    def create_provider(name = nil, url = nil, username = nil, box_name = nil, version_number = nil)
+      update_data = !(username && version_number && provider_name && box_name)
+      name ||= @name
+      url ||= @url
+      username ||= @username
+      box_name ||= @box_name
+      version_number ||= @version
+
+      params = { name: name, url: url }.delete_if { |_, v| v.nil? }
+      data = @client.request('post', create_provider_path(username, box_name, version_number), provider: params)
+
+      @data = data if update_data
+      data
     end
 
     # @param [String] url
-    def update(url)
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    # @param [String] provider_name
+    def update(url = nil, username = nil, box_name = nil, version_number = nil, provider_name = nil)
+      update_data = !(username && version_number && provider_name && box_name)
+      provider_name ||= @name
+      url ||= @url
+      username ||= @username
+      box_name ||= @box_name
+      version_number ||= @version
+
       params = { url: url }
-      @data = account.request('put', provider_path, provider: params)
+      data = @client.request('put',
+                             provider_path(username, box_name, version_number, provider_name),
+                             provider: params)
+
+      @data = data if update_data
+      data
     end
 
-    def delete
-      account.request('delete', provider_path)
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    # @param [String] provider_name
+    def delete(username = nil, box_name = nil, version_number = nil, provider_name = nil)
+      @client.request('delete', provider_path(username, box_name, version_number, provider_name))
     end
 
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    # @param [String] provider_name
     # @return [String]
-    def upload_url
-      account.request('get', "#{provider_path}/upload")['upload_path']
+    def upload_url(username = nil, box_name = nil, version_number = nil, provider_name = nil)
+      @client.request('get', "#{provider_path(username, box_name, version_number, provider_name)}/upload")['upload_path']
     end
 
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    # @param [String] provider_name
     # @param [String] file_path
-    def upload_file(file_path)
-      url = upload_url
+    def upload_file(file_path, username = nil, box_name = nil, version_number = nil, provider_name = nil)
+      url = upload_url(username, box_name, version_number, provider_name)
       payload = File.open(file_path, 'r')
       RestClient::Request.execute(
         method: :put,
@@ -67,8 +130,20 @@ module VagrantCloud
       box.account
     end
 
-    def provider_path
-      "/box/#{account.username}/#{box.name}/version/#{version.number}/provider/#{name}"
+    def create_provider_path(username = nil, box_name = nil, version_number = nil)
+      if username && box_name && version_number
+        "/box/#{username}/#{box_name}/version/#{version_number}/providers"
+      else
+        "/box/#{account.username}/#{box.name}/version/#{version.number}/providers"
+      end
+    end
+
+    def provider_path(username = nil, box_name = nil, version_number = nil, provider_name = nil)
+      if username && box_name && version_number && name
+        "/box/#{username}/#{box_name}/version/#{version_number}/provider/#{provider_name}"
+      else
+        "/box/#{account.username}/#{box.name}/version/#{version.number}/provider/#{name}"
+      end
     end
   end
 end

data/lib/vagrant_cloud/search.rb

@@ -0,0 +1,31 @@
+module VagrantCloud
+  class Search
+    attr_accessor :account
+
+    def initialize(access_token = nil, custom_server = nil)
+      @client = Client.new(access_token, custom_server)
+    end
+
+    # Requests a search based on the given parameters
+    #
+    # @param [String] query
+    # @param [String] provider
+    # @param [String] sort
+    # @param [String] order
+    # @param [String] limit
+    # @param [String] page
+    # @return [Hash]
+    def search(query = nil, provider = nil, sort = nil, order = nil, limit = nil, page = nil)
+      params = {
+        q: query,
+        provider: provider,
+        sort: sort,
+        order: order,
+        limit: limit,
+        page: page
+      }.delete_if { |_, v| v.nil? }
+
+      @client.request('get', '/search', params)
+    end
+  end
+end

data/lib/vagrant_cloud/version.rb

@@ -2,17 +2,24 @@ module VagrantCloud
   class Version
     attr_accessor :box
     attr_accessor :number
-    attr_accessor :data
 
     # @param [Box] box
     # @param [String] number
     # @param [Hash] data
-    def initialize(box, number, data = nil)
+    # @param [String] description
+    # @param [String] access_token
+    def initialize(box, number, data = nil, description = nil, access_token = nil, custom_server = nil)
       @box = box
       @number = number
       @data = data
+      @description = description
+      @client = Client.new(access_token, custom_server)
     end
 
+    #--------------------
+    # Metadata Helpers
+    #--------------------
+
     # @return [String]
     def version
       data['version'].to_s
@@ -38,29 +45,88 @@ module VagrantCloud
       version
     end
 
+    #--------------------
+    # Version API Helpers
+    #--------------------
+
     # @return [Hash]
     def data
-      @data ||= account.request('get', "/box/#{account.username}/#{box.name}/version/#{number}")
+      @data ||= @client.request('get', version_path)
+    end
+
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    # @return [Hash]
+    def read(username = nil, box_name = nil, version_number = nil)
+      @client.request('get', version_path(username, box_name, version_number))
     end
 
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
     # @param [String] description
-    def update(description)
+    def update(description = nil, username = nil, box_name = nil, version_number = nil)
+      update_data = !(username && box_name && version_number)
+      description ||= @description
       version = { description: description }
-      @data = account.request('put', "/box/#{account.username}/#{box.name}/version/#{number}", version: version)
+      data = @client.request('put',
+                             version_path(username, box_name, version_number),
+                             version: version)
+
+      @data = data if update_data
+      data
     end
 
-    def delete
-      account.request('delete', "/box/#{account.username}/#{box.name}/version/#{number}")
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    def delete(username = nil, box_name = nil, version_number = nil)
+      @client.request('delete', version_path(username, box_name, version_number))
     end
 
-    def release
-      @data = account.request('put', "/box/#{account.username}/#{box.name}/version/#{number}/release")
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    def release(username = nil, box_name = nil, version_number = nil)
+      data = @client.request('put', "#{version_path(username, box_name, version_number)}/release")
+
+      @data = data if !(username && box_name && version_number)
+      data
     end
 
-    def revoke
-      @data = account.request('put', "/box/#{account.username}/#{box.name}/version/#{number}/revoke")
+    # @param [String] username
+    # @param [String] box_name
+    # @param [String] version_number
+    def revoke(username = nil, box_name = nil, version_number = nil)
+      update_data = !(username && box_name && version_number)
+      data = @client.request('put', "#{version_path(username, box_name, version_number)}/revoke")
+
+      @data = data if update_data
+      data
     end
 
+    # @param [String] number
+    # @param [String] description
+    # @param [String] org
+    # @param [String] box_name
+    # @return [Hash]
+    def create_version(number = nil, description = nil, org = nil, box_name = nil)
+      update_data = !(org && box_name && description && number)
+      number ||= @number
+      description ||= @description
+
+      params = { version: number, description: description }
+      data = @client.request('post', create_version_path(org, box_name).to_s, version: params)
+
+      @data = data if update_data
+      data
+    end
+
+    #--------------------
+    # Old Provider Helpers
+    #--------------------
+
     # @param [String] name
     # @param [Hash] data
     # @return [Provider]
@@ -72,8 +138,8 @@ module VagrantCloud
     # @param [String] url
     # @return [Provider]
     def create_provider(name, url = nil)
-      params = { name: name, url: url }.delete_if { |_k, v| v.nil? }
-      data = account.request('post', "/box/#{account.username}/#{box.name}/version/#{number}/providers", provider: params)
+      params = { name: name, url: url }.delete_if { |_, v| v.nil? }
+      data = @client.request('post', "#{version_path}/providers", provider: params)
       get_provider(name, data)
     end
 
@@ -81,8 +147,8 @@ module VagrantCloud
     # @param [String] url
     # @return [Provider]
     def ensure_provider(name, url)
-      provider = providers.select { |provider| provider.name == name }.first
-      provider = create_provider(name, url) unless provider
+      provider = providers.select { |p| p.name == name }.first
+      provider ||= create_provider(name, url)
       provider.update(url) if url != provider.url
       provider
     end
@@ -93,5 +159,30 @@ module VagrantCloud
     def account
       box.account
     end
+
+    # Path used to generate a new version on a box
+    #
+    # @param [String] - username
+    # @param [String] - box_name
+    # @return [String]
+    def create_version_path(username = nil, box_name = nil)
+      if username && box_name
+        "/box/#{username}/#{box_name}/versions"
+      else
+        "/box/#{account.username}/#{box.name}/versions"
+      end
+    end
+
+    # @param [String] - username
+    # @param [String] - box_name
+    # @param [String] - version_number
+    # @return [String]
+    def version_path(username = nil, box_name = nil, version_number = nil)
+      if username && box_name && version_number
+        "/box/#{username}/#{box_name}/version/#{version_number}"
+      else
+        "/box/#{account.username}/#{box.name}/version/#{number}"
+      end
+    end
   end
 end

data/lib/vagrant_cloud.rb

@@ -1,10 +1,11 @@
-module VagrantCloud
-  require 'json'
-  require 'rest_client'
+require 'json'
+require 'rest_client'
 
-  require 'vagrant_cloud/account'
-  require 'vagrant_cloud/box'
-  require 'vagrant_cloud/version'
-  require 'vagrant_cloud/provider'
-  require 'vagrant_cloud/cli'
-end
+require 'vagrant_cloud/errors'
+
+require 'vagrant_cloud/account'
+require 'vagrant_cloud/box'
+require 'vagrant_cloud/version'
+require 'vagrant_cloud/provider'
+require 'vagrant_cloud/search'
+require 'vagrant_cloud/client'

metadata

@@ -1,43 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: vagrant_cloud
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
+- HashiCorp
 - Cargo Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2018-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,38 +68,36 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.59.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.59.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
-description: Minimalistic ruby client for the HashiCorp Atlas API (previously Vagrant
-  Cloud API)
-email: tech@cargomedia.ch
-executables:
-- vagrant_cloud
+        version: '3.0'
+description: Ruby library for the HashiCorp Vagrant Cloud API
+email: vagrant@hashicorp.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -108,14 +107,20 @@ files:
 - lib/vagrant_cloud.rb
 - lib/vagrant_cloud/account.rb
 - lib/vagrant_cloud/box.rb
-- lib/vagrant_cloud/cli.rb
+- lib/vagrant_cloud/client.rb
+- lib/vagrant_cloud/errors.rb
 - lib/vagrant_cloud/provider.rb
+- lib/vagrant_cloud/search.rb
 - lib/vagrant_cloud/version.rb
-homepage: https://github.com/cargomedia/vagrant_cloud
+homepage: https://github.com/hashicorp/vagrant_cloud
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |-
+  NOTICE: As of the 2.0.0 release, the vagrant_cloud gem provides library functionality
+          and no longer includes a command line client. For a command line client,
+          use the `vagrant cloud` subcommand from Vagrant. Vagrant can be downloaded
+          from: https://www.vagrantup.com/downloads.html
 rdoc_options: []
 require_paths:
 - lib
@@ -131,8 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
-summary: HashiCorp Atlas API client
+summary: Vagrant Cloud API Library
 test_files: []

data/lib/vagrant_cloud/cli.rb

@@ -1,65 +0,0 @@
-require 'thor'
-
-module VagrantCloud
-  class Cli < Thor
-    package_name 'VagrantCloud'
-
-    class_option :username, alias: '-u', required: true, desc: 'Vagrant Cloud username'
-    class_option :token, alias: '-t', required: true, desc: 'Vagrant Cloud access token'
-    class_option :box, alias: '-b', required: true, desc: 'name of the box'
-    class_option :verbose, type: :boolean
-
-    desc 'create_version', 'creates a new version within a given box'
-    method_option :version, alias: '-v', required: true, desc: 'version within the box'
-    def create_version
-      version = current_box.create_version(options[:version])
-      puts "created #{version.version} of box #{options[:box]}; current status is #{version.status}" if options[:verbose]
-      version
-    end
-
-    desc 'release_version', 'release the specified version within a given box'
-    method_option :version, alias: '-v', required: true, desc: 'version within the box'
-    def release_version
-      version = current_version
-      version.release
-      puts "Box #{options[:box]} / version: #{version.version}; current status is #{version.status}" if options[:verbose]
-      true
-    end
-
-    desc 'create_provider', 'creates a provider within a given box and version'
-    method_option :version, alias: '-v', required: true, desc: 'version within the box'
-    method_option :provider, alias: '-p', default: 'virtualbox', desc: 'the provider for the box; default: virtualbox'
-    method_option :provider_url, alias: '-pu', desc: 'URL to the file for remote hosting; do not include if you intend to upload a file subsequently'
-    def create_provider
-      provider = current_version.create_provider(options[:provider], options[:provider_url])
-      puts "created #{provider.data['name']} provider within version #{provider.version.version}" if options[:verbose]
-      provider
-    end
-
-    desc 'upload_file', 'upload a file for Atlas to host to an existing version and provider'
-    method_option :version, alias: '-v', required: true, desc: 'version within the box'
-    method_option :provider, alias: '-p', default: 'virtualbox', desc: 'the provider for the box; default: virtualbox'
-    method_option :provider_file_path, alias: '-pfp', required: true, desc: 'path to file to be uploaded for Atlast hosting'
-    def upload_file
-      get_provider(options[:provider]).upload_file(options[:provider_file_path])
-    end
-
-    private
-
-    def current_account
-      VagrantCloud::Account.new(options[:username], options[:token])
-    end
-
-    def current_box
-      current_account.get_box(options[:box])
-    end
-
-    def current_version
-      current_box.get_version(options[:version])
-    end
-
-    def get_provider(provider_str)
-      current_version.get_provider(provider_str)
-    end
-  end
-end