vagrant_cloud 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcdd9dd3b5ac00bf1add77d8a837f727c61c0041
-  data.tar.gz: 2bd31b671ba202ca7b2cbba4a06e767949732b95
+  metadata.gz: 6a617453ddbb1ae2c011a4bfefc491b5d4bbb9ae
+  data.tar.gz: 9c29257f990145ffa7d0dcae07b4eef07d9e105b
 SHA512:
-  metadata.gz: 72b0c2dbc26b450f46df0eb47111ea80742e4890a1ff143cb7e9ad03c724e499368c69eb5d4c4378a851261bd948801d2d928f9ccd97633a40e4c04de5ef7d8a
-  data.tar.gz: 9b11a23883516758c7da2f4f0f851ea270030a9c4b128d62260f7503005835bbcf8b06cbf693b065197331a6d84d9713785da6a4d178e2d7e1bc0f849e1ba6a5
+  metadata.gz: f24a18bc5a0bbdc4d15ea65971ae3cc938f4edb248866c03fc07381b5856e4db516d687d423f9f62312b61278afc8e20ef505d8924c030516100f070d7d44d44
+  data.tar.gz: a431af85399f329ce7d30289d3140f7d58b53339b3db6dd3f466b3dddb889e376275eec9ab5af8d69814cced872c488d2265ea844066c0bb21c59ef8093f233d

data/README.md

@@ -1,7 +1,7 @@
-vagrant_cloud
+vagrant_cloud [![Build Status](https://travis-ci.org/cargomedia/vagrant_cloud.svg)](https://travis-ci.org/cargomedia/vagrant_cloud)
 =============
 
-*Very* minimalistic ruby wrapper for the [Vagrant Cloud API](https://vagrantcloud.com/api).
+*Very* minimalistic ruby wrapper for the [Vagrant Cloud API](https://atlas.hashicorp.com/docs).
 
 Consisting of four basic classes for your *account*, *boxes*, *versions* and *providers*.
 

data/lib/vagrant_cloud/account.rb

@@ -5,62 +5,108 @@ module VagrantCloud
     attr_accessor :username
     attr_accessor :access_token
 
+    # @param [String] username
+    # @param [String] access_token
     def initialize(username, access_token)
       @username = username
       @access_token = access_token
     end
 
+    # @param [String] name
+    # @param [Hash]
+    # @return [Box]
     def get_box(name, data = nil)
       Box.new(self, name, data)
     end
 
-    def create_box(name, description = nil, is_private = false)
-      params = {:name => name}
-      params[:description] = description if description
-      params[:short_description] = description if description
-      params[:is_private] = is_private ? 1 : 0
+    # @param [String] name
+    # @param [Hash] args
+    # @return [Box]
+    def create_box(name, *args)
+      params = box_params(*args)
+      params[:name] = name
+
       data = request('post', '/boxes', {:box => params})
       get_box(name, data)
     end
 
-    def ensure_box(name, description = nil, is_private = nil)
+    # @param [String] name
+    # @param [Hash] args
+    # @return [Box]
+    def ensure_box(name, *args)
+      params = box_params(*args)
+
       begin
         box = get_box(name)
         box.data
       rescue RestClient::ResourceNotFound => e
-        box = create_box(name, description, is_private)
+        box = create_box(name, params)
+        # If we've just created the box, we're done.
+        return box
       end
 
-      updated_description = (!description.nil? && (description != box.description || description != box.description_short))
-      updated_private = (!is_private.nil? && (is_private != box.private))
-      if updated_description || updated_private
-        box.update(description, is_private)
-      end
+      # Select elements from params that don't match what we have in the box
+      # data. These are changed parameters and should be updated.
+      update_params = params.select { |k,v|
+        box.data[box.param_name(k)] != v
+      }
+
+      # Update the box with any params that had changed.
+      box.update(update_params) unless update_params.empty?
 
       box
     end
 
+    # @param [String] method
+    # @param [String] path
+    # @param [Hash] params
+    # @return [Hash]
     def request(method, path, params = {})
       params[:access_token] = access_token
-      headers = {:access_token => access_token}
       result = RestClient::Request.execute(
-          :method => method,
-          :url => url_base + path,
-          :payload => params,
-          :headers => headers,
-          :ssl_version => 'TLSv1'
+        :method => method,
+        :url => url_base + path,
+        :payload => params,
+        :ssl_version => 'TLSv1'
       )
       result = JSON.parse(result)
       errors = result['errors']
-      raise "Vagrant Cloud returned error: #{errors}" if errors
+      raise(RuntimeError, "Vagrant Cloud returned error: #{errors}") if errors
       result
     end
 
     private
 
+    # @return [String]
     def url_base
       'https://vagrantcloud.com/api/v1'
     end
 
+    # @param [Array] args
+    # @return [Hash]
+    def box_params(*args)
+      # Prepares a hash based on the *args array passed in.
+      # Acceptable parameters are those documented by Hashicorp for the v1 API
+      # at https://atlas.hashicorp.com/docs
+
+      # This dance is to simulate what we could have accomplished with **args
+      # in Ruby 2.0+
+      # This will silently discard any options that are not passed in as a
+      # hash.
+      # Find and remove the first hash we find in *args. Set params to an
+      # empty hash if we weren't passed one.
+      params = args.select { |v| v.is_a?(Hash) }.first
+      if params.nil?
+        params = {}
+      else
+        args.delete_if { |v| v == params }
+      end
+
+      # Default boxes to public can be overridden by providing :is_private
+      params[:is_private] = false unless defined? params[:is_private]
+
+      params
+    end
+
   end
 end

data/lib/vagrant_cloud/box.rb

@@ -6,50 +6,60 @@ module VagrantCloud
     attr_accessor :name
     attr_accessor :data
 
+    # @param [String] account
+    # @param [String] name
+    # @param [Hash] data
     def initialize(account, name, data = nil)
       @account = account
       @name = name
       @data = data
     end
 
+    # @return [String]
     def description
-      data['description_markdown']
+      data['description_markdown'].to_s
     end
 
+    # @return [String]
     def description_short
-      data['short_description']
+      data['short_description'].to_s
     end
 
+    # @return [TrueClass, FalseClass]
     def private
-      data['private']
+      !!data['private']
     end
 
+    # @return [Array<Version>]
     def versions
-      version_list = data['versions'].map { |data| Version.new(self, data['number'], data) }
+      version_list = data['versions'].map { |data| VagrantCloud::Version.new(self, data['number'], data) }
       version_list.sort_by { |version| Gem::Version.new(version.number) }
     end
 
+    # @return [Hash]
     def data
       @data ||= account.request('get', "/box/#{account.username}/#{name}")
     end
 
-    def update(description, is_private)
-      box = {
-        :short_description => description,
-        :description => description,
-        :is_private => is_private,
-      }
-      @data = account.request('put', "/box/#{account.username}/#{name}", {:box => box})
+    # @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
 
+    # @param [Integer] number
+    # @param [Hash] data
+    # @return [Version]
     def get_version(number, data = nil)
-      Version.new(self, number, data)
+      VagrantCloud::Version.new(self, number, data)
     end
 
+    # @param [String] name
+    # @param [String] description
+    # @return [Version]
     def create_version(name, description = nil)
       params = {:version => name}
       params[:description] = description if description
@@ -57,6 +67,9 @@ module VagrantCloud
       get_version(data['number'], data)
     end
 
+    # @param [String] name
+    # @param [String] description
+    # @return [Version]
     def ensure_version(name, description = nil)
       version = versions.select { |version| version.version == name }.first
       unless version
@@ -68,5 +81,21 @@ module VagrantCloud
       version
     end
 
+    # @param [Symbol]
+    # @return [String]
+    def param_name(param)
+      # This needs to return strings, otherwise it won't match the JSON that
+      # Vagrant Cloud returns.
+      ATTR_MAP.fetch(param, param.to_s)
+    end
+
+    private
+
+    # Vagrant Cloud returns keys different from what you set for some params.
+    # Values in this map should be strings.
+    ATTR_MAP = {
+      :is_private  => 'private',
+      :description => 'description_markdown',
+    }
   end
 end

data/lib/vagrant_cloud/provider.rb

@@ -6,24 +6,31 @@ module VagrantCloud
     attr_accessor :name
     attr_accessor :data
 
+    # @param [Version] version
+    # @param [String] name
+    # @param [Hash] data
     def initialize(version, name, data = nil)
       @version = version
       @name = name
       @data = data
     end
 
+    # @return [String]
     def url
-      data['original_url']
+      data['original_url'].to_s
     end
 
+    # @return [String]
     def download_url
-      data['download_url']
+      data['download_url'].to_s
     end
 
+    # @return [Hash]
     def data
       @data ||= account.request('get', "/box/#{account.username}/#{box.name}/version/#{version.number}/provider/#{name}")
     end
 
+    # @param [String] url
     def update(url)
       params = {:url => url}
       @data = account.request('put', "/box/#{account.username}/#{box.name}/version/#{version.number}/provider/#{name}", {:provider => params})
@@ -35,10 +42,12 @@ module VagrantCloud
 
     private
 
+    # @return [Box]
     def box
       version.box
     end
 
+    # @return [Account]
     def account
       box.account
     end

data/lib/vagrant_cloud/version.rb

@@ -6,36 +6,46 @@ module VagrantCloud
     attr_accessor :number
     attr_accessor :data
 
+    # @param [Box] box
+    # @param [String] number
+    # @param [Hash] data
     def initialize(box, number, data = nil)
       @box = box
       @number = number
       @data = data
     end
 
+    # @return [String]
     def version
-      data['version']
+      data['version'].to_s
     end
 
+    # @return [String]
     def description
-      data['description_markdown']
+      data['description_markdown'].to_s
     end
 
+    # @return [String]
     def status
-      data['status']
+      data['status'].to_s
     end
 
+    # @return [Array<Provider>]
     def providers
       data['providers'].map { |data| Provider.new(self, data['name'], data) }
     end
 
+    # @return [String]
     def to_s
       version
     end
 
+    # @return [Hash]
     def data
       @data ||= account.request('get', "/box/#{account.username}/#{box.name}/version/#{number}")
     end
 
+    # @param [String] description
     def update(description)
       version = {:description => description}
       @data = account.request('put', "/box/#{account.username}/#{box.name}/version/#{number}", {:version => version})
@@ -53,16 +63,25 @@ module VagrantCloud
       @data = account.request('put', "/box/#{account.username}/#{box.name}/version/#{number}/revoke")
     end
 
+    # @param [String] name
+    # @param [Hash] data
+    # @return [Provider]
     def get_provider(name, data = nil)
       Provider.new(self, name, data)
     end
 
+    # @param [String] name
+    # @param [String] url
+    # @return [Provider]
     def create_provider(name, url)
       params = {:name => name, :url => url}
       data = account.request('post', "/box/#{account.username}/#{box.name}/version/#{self.number}/providers", {:provider => params})
       get_provider(name, data)
     end
 
+    # @param [String] name
+    # @param [String] url
+    # @return [Provider]
     def ensure_provider(name, url)
       provider = providers.select{ |provider| provider.name == name }.first
       unless provider
@@ -76,6 +95,7 @@ module VagrantCloud
 
     private
 
+    # @return [Account]
     def account
       box.account
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant_cloud
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Cargo Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 description: Very minimalistic ruby wrapper for the Vagrant Cloud API
 email: hello@cargomedia.ch
 executables: []
@@ -71,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Vagrant Cloud API wrapper